Difference between revisions of "LlSetSitText"

From Second Life Wiki
Jump to navigation Jump to search
m (grammar)
m (Replaced old <LSL> block with <source lang="lsl2">)
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{LSL_Function
{{Issues/SVC-4870}}{{LSL_Function
|func_id=242|func_sleep=0.0|func_energy=10.0
|func_id=242|func_sleep=0.0|func_energy=10.0
|func=llSetSitText|p1_type=string|p1_name=text
|func=llSetSitText|p1_type=string|p1_name=text
|func_footnote='''text''' is limited to 9 characters.
|func_footnote
|func_desc=Displays '''text''' rather than "Sit" in pie menu
|func_desc=Displays '''text''' rather than the default "Sit Here" in the right-click menu.
|return_text
|return_text
|spec
|spec=
|caveats
|caveats=*'''Text''' will only be displayed if set by a script calling this function in the root. If '''text''' is set by a script in a child the '''text''' will only be displayed after unlinking it or relinking it as the root. If either a child or the root is selected as an individual prim and right clicked, the '''text''' displayed will be the default even if a script in the root has set '''text'''. More simply - The '''text''' property displayed on right click will always be that of the root unless, right clicking a prim under individual edit when it will always be the LL default.
|constants
*Note that like particles, and the other set text functions, all '''text''' set via llSetSitText becomes a property of a  prim, not a script. For that reason, the '''text''' will remain if the script that set it is deactivated or even removed.
|examples=<lsl>default
*You have no control over the face, size or colour of the displayed '''text'''.
*'''Text''' is limited to 9 characters.
|examples=
===Usage===
 
<source lang="lsl2">default
{
{
     state_entry()
     state_entry()
     {
     {
         llSetSitText("Sit here");
         llSetSitText("Be Seated");
     }
     }
}</lsl>
}</source>
 
=== Removing Sit Text ===
There is no way to stop a pie menu from having a "Sit Here" space reserved on it. Although by setting the string to a space no text will be shown.
 
To remove custom text that you have placed there, set the text as an empty string like this: "".
 
<source lang="lsl2">default
{
    state_entry()
    {
        llSetSitText("");
    }
}</source>
 
Upon your having done so, the text that appears will revert to "Sit Here."
 
|helpers
|helpers
|also_functions=
|also_functions=
Line 23: Line 44:
|also_articles
|also_articles
|notes
|notes
|permission
|negative_index
|cat1=Pie Menu
|cat1=Pie Menu
|cat2=Prim
|cat2=Prim
|cat3=Sit
|cat3=Sit
|cat4
|cat4=Text
}}
}}

Latest revision as of 14:03, 22 January 2015

Summary

Function: llSetSitText( string text );

Displays text rather than the default "Sit Here" in the right-click menu.

• string text

Caveats

  • Text will only be displayed if set by a script calling this function in the root. If text is set by a script in a child the text will only be displayed after unlinking it or relinking it as the root. If either a child or the root is selected as an individual prim and right clicked, the text displayed will be the default even if a script in the root has set text. More simply - The text property displayed on right click will always be that of the root unless, right clicking a prim under individual edit when it will always be the LL default.
  • Note that like particles, and the other set text functions, all text set via llSetSitText becomes a property of a prim, not a script. For that reason, the text will remain if the script that set it is deactivated or even removed.
  • You have no control over the face, size or colour of the displayed text.
  • Text is limited to 9 characters.

Important Issues

~ All Issues ~ Search JIRA for related Bugs
   llSetSitText does not apply for child prims, only the main prims sit text gets displayed

Examples

Usage

default
{
    state_entry()
    {
        llSetSitText("Be Seated");
    }
}

Removing Sit Text

There is no way to stop a pie menu from having a "Sit Here" space reserved on it. Although by setting the string to a space no text will be shown.

To remove custom text that you have placed there, set the text as an empty string like this: "".

default
{
    state_entry()
    {
        llSetSitText("");
    }
}
Upon your having done so, the text that appears will revert to "Sit Here."

See Also

Functions

•  llSitTarget
•  llSetTouchText

Deep Notes

All Issues

~ Search JIRA for related Issues
   llSetSitText does not apply for child prims, only the main prims sit text gets displayed

Signature

function void llSetSitText( string text );