Template:LSL Function

Experimental LSL Function Template

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

Usage example:

{{LSL_Function|name=llFunction|returnType=string
|functionID=14|energy=10.0|sleep=0.0
|paramName1=avatar|paramType1=key|paramDesc1=This is a key parameter which expects to be passed a valid avatar key.
|paramName2=widgets|paramType2=integer|paramDesc2=This is an integer parameter which indicates the number of widgets to process.
|paramName3=stickLength|paramType3=float|paramDesc3=This is a float parameter used to describe the length of the stick used to whack bad formatters.
|description=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.)

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)

string llFunction(key avatar, integer widgets, float stickLength ); 14( ); 0.0 Function ID 10.0 Delay Energy avatar - This is a key parameter which expects to be passed a valid avatar key. widgets - This is an integer parameter which indicates the number of widgets to process. 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 (bulleted footnotes, if necessary - caveats should go in caveats section)

---