Difference between revisions of "LSL Function Style"

From Second Life Wiki
Jump to navigation Jump to search
(change message at top now that I know the status...)
Line 3: Line 3:
  '''WORK IN PROGRESS'''
  '''WORK IN PROGRESS'''
<div style="padding: 0.5em;background:#ffffff;">
<div style="padding: 0.5em;background:#ffffff;">
''(This style and layout is presumed to be not finalized yet - this needs to be rather finalized first.)''
''(This style and layout is not finalized yet - this needs to be finalized ''before'' significant information is added to articles!)''
</div>
</div>
</div>
</div>

Revision as of 23:13, 30 January 2007

  WORK IN PROGRESS

(This style and layout is not finalized yet - this needs to be finalized before significant information is added to articles!)

string llFunction( key avatar, integer widgets , float stickLength );

0 Function ID
0.0 Delay
10.0 Energy

This function consumes widgets while it simultaneously animates a person whacking bad formatters. The widgets are destroyed. This is the lede. (short high-level description of function, a few sentences to a paragraph)

Returns a string contains the name of the widget last consumed.

• key avatar – This is a key parameter which expects to be passed a valid avatar key.
• integer widgets – This is an integer parameter which indicates the number of widgets to process.
• float stickLength – This is a float parameter used to describe the length of the stick used to whack bad formatters.

Specification

This function performs this specific set of actions under these circumstances. If the key passed to it is NULL_KEY, then it will shout "Nobody's whacking!" on channel 0.

Caveats

  • Don't use this function to test whether a key is null.
  • (if you know of none, try using:) None known

Examples

<lsl> default {

   state_entry()
   {
       llSay(0,"The absolute value of -4 is: "+(string)llAbs(-4) );
   }

} </lsl>

Helper Functions

<lsl> </lsl>

See Also

(similar functions, related examples and pages, etc.)

Notes

(footnotes, if necessary - caveats should go in caveats section)

Summary

Function: string llFunction( key avatar, integer widgets, float stickLength );

This function consumes widgets while it simultaneously animates a person whacking bad formatters. The widgets are destroyed. This is the lede. (short high-level description of function, a few sentences to a paragraph)
Returns a string contains the name of the widget last consumed.

• key avatar This is a key parameter which expects to be passed a valid avatar key.
• integer widgets This is an integer parameter which indicates the number of widgets to process.
• float stickLength This is a float parameter used to describe the length of the stick used to whack bad formatters.

Specification

This function performs this specific set of actions under these circumstances. If the key passed to it is NULL_KEY, then it will shout "Nobody's whacking!" on channel 0.

Flag Inventory Type
INVENTORY_NONE -1 Item does not exist.
INVENTORY_ALL Any inventory type.
INVENTORY_TEXTURE 0 texture
INVENTORY_SOUND 1 sound
INVENTORY_LANDMARK 3 landmark
INVENTORY_CLOTHING 5 clothing
INVENTORY_OBJECT 6 object
Flag Inventory Type
INVENTORY_NOTECARD 7 notecard
INVENTORY_SCRIPT 10 script
INVENTORY_BODYPART 13 body part
INVENTORY_ANIMATION 20 animation
INVENTORY_GESTURE 21 gesture
INVENTORY_SETTING 56 setting
INVENTORY_MATERIAL 57 material

Caveats

  • Don't use this function to test whether a key is null.
All Issues ~ Search JIRA for related Bugs

Examples

<lsl></lsl>

Useful Snippets

<lsl></lsl>

Notes

(footnotes, if necessary - caveats should go in caveats section)

See Also

(similar functions, related examples and pages, etc.)

Deep Notes

Search JIRA for related Issues

Signature

function string llFunction( key avatar, integer widgets, float stickLength );