Template:LSL Function

From Second Life Wiki
Revision as of 14:58, 25 January 2007 by Thraxis Epsilon (talk | contribs)
Jump to navigation Jump to search


Experimental LSL Function Template

This is an experimental template for the LSL function page format.

Usage example:

{{LSL_Function
|name=llFunction|14|0.0|10.0
|r=string
|p1=avatar
|p1t=key
|p1d=This is a key parameter which expects to be passed a valid avatar key.
|p2=widgets
|p2t=integer
|p2d=This is an integer parameter which indicates the number of widgets to process.
|p3=stickLength
|p3t=float
|p3d=This is a float parameter used to describe the length of the stick used to whack bad formatters.
|tb=This function consumes widgets while it simultaneously animates a person whacking bad formatters.  The widgets are destroyed.  This is the lede. <!-- yes, lede is a word -->  (short high-level description of function, a few sentences to a paragraph)
|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>
|helpers=
<lsl>
</lsl>
|seeAlso=
(similar [[LSL Functions|functions]], related [[LSL Examples|examples]] and pages, etc.)
|notes=
* (bulleted footnotes, if necessary - caveats should go in caveats section)
}}

Produces:


The correct title of this article is Template:llFunction. The initial letter is shown capitalized due to technical restrictions.

  WORK IN PROGRESS

(This style and layout is presumed to be not finalized yet - this needs to be rather finalized first.)

{

r=string

p1t=key p2t=integer p3t=float p4={{{p4}}} p5={{{p5}}} p6={{{p6}}} p7={{{p7}}} p8={{{p8}}} p9={{{p9}}}

tb=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)

}}}

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

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



Bugs

Suggested Changes