Difference between revisions of "LSL Function Style"
Jump to navigation
Jump to search
Talarus Luan (talk | contribs) |
(big changes - better for those unfamiliar with function (assuming this wasn't some sort of official thing, yet)) |
||
| Line 1: | Line 1: | ||
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) | |||
''(This style and layout is presumed to be not finalized yet.)'' | |||
== | ==Syntax== | ||
integer llFunction( key avatar, integer widgets, float stickLength); | |||
* 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. | ||
* | |||
==Examples | ==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== | |||
(code blocks) | (code blocks) | ||
== | ==See also== | ||
(similar functions, related examples and pages, etc.) | |||
==Notes== | |||
(footnotes, if necessary - caveats should go in caveats section) | |||
Revision as of 18:14, 24 January 2007
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)
(This style and layout is presumed to be not finalized yet.)
Syntax
integer llFunction( key avatar, integer widgets, float stickLength);
- 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
(code blocks)
See also
(similar functions, related examples and pages, etc.)
Notes
(footnotes, if necessary - caveats should go in caveats section)