Difference between revisions of "LlSetText"

From Second Life Wiki
Jump to navigation Jump to search
m (fixed example code)
Line 1: Line 1:
{{LSL_Function
{{LSL_Function
|function name = llSetText
|func_id=152
|func_id=llSetText
|func_sleep=0.0
|func_sleep=
|func_energy=10.0
|func_energy=
|func=llSetText
|func=llSetText
|sort=SetText
|sort=SetText
|p1_type=string
|p1_type=string
|p1_name=text
|p1_name=text
|p1d = text to display between the quotes
|p1_desc=text to display between the quotes
|p2_type=vector
|p2_type=vector
|p2_name=color
|p2_name=color
|p2d = color in RGB enclosed between <> signs, as in <0.0, 0.0, 0.0> = black, <1.0, 1.0, 1.0> = white.
|p2_desc=color in RGB, <0.0, 0.0, 0.0> = black, <1.0, 1.0, 1.0> = white.
|p3_type=float
|p3_type=float
|p3_name=alpha
|p3_name=alpha
|p3d = visibility, 0.0 is fully transparent and 1.0 is fully visible.
|p3_desc=visibility, 0.0 is fully transparent and 1.0 is fully visible.
llSetText(string text, vector color, float alpha);
 
|func_desc=This function is used to set text to display over an object in SL.
|func_desc=This function is used to set text to display over an object in SL.
|return_text
|return_text

Revision as of 04:49, 8 February 2007

Summary

Function: llSetText( string text, vector <span title="color in RGB, <0.0, 0.0, 0.0> = black, <1.0, 1.0, 1.0> = white." style="border-bottom:1px dotted; cursor:help;">color, float alpha );
0.0 Forced Delay
10.0 Energy

This function is used to set text to display over an object in SL.

• string text text to display between the quotes
• vector color color in RGB, <0.0, 0.0, 0.0> = black, <1.0, 1.0, 1.0> = white.
• float alpha visibility, 0.0 is fully transparent and 1.0 is fully visible.

Specification

Displays text placed over object -- programmer specifies text, color and visibility/transparency.

Caveats

The floating text is a property of the prim and not the script, thus the text will remain if the script is deactivated or removed. To remove floating text, one must assign an empty string with llSetText("", <1.0, 1.0, 1.0>, 1.0);

Examples

Example colors:

vector white = <1.0, 1.0, 1.0>;
vector red = <1.0, 0.0, 0.0>;
vector green = <0.0, 1.0, 0.0>;
vector blue = <0.0, 0.0, 1.0>;
vector grey = <0.5, 0.5, 0.5>;
vector black = <0.0, 0.0, 0.0>;
llSetText("I am on", <1.0, 1.0, 1.0>, 1.0);

<1.0, 1.0, 1.0> represents the values for red, green, and blue. <1.0, 1.0, 1.0>, means "white" and <0.0, 0.0, 0.0> means "black".

llSetText("I am off", <0.0, 0.0, 0.0>, 1.0);

The 1.0 is the alpha setting. 1.0 means fully opaque, and 0.0 would be completely transparent (invisible).

Example of how llSetText could be included in default code:

default
{
    state_entry()
    {
         llSay(0, "Hello, Avatar!");
         llSetText("Prize Box", <0.0, 1.0, 0.0>, 1.0);
    }

    touch_start(integer total_number)
    {
         llSay(0, "Touched.");
    }
}

Notes

Most commonly, this is included in the default code for an object (see example above).

Deep Notes

Signature

function void llSetText( string text, vector color, float alpha );