Difference between revisions of "LSL Function Style"

From Second Life Wiki
Jump to navigation Jump to search
m (removed the TOC)
m (rm extraneous space)
Line 6: Line 6:


==Syntax==
==Syntax==
integer llFunction( key avatar, integer widgets, float stickLength);
integer llFunction(key avatar, integer widgets, float stickLength);


* avatar - This is a key parameter which expects to be passed a valid avatar key.
* avatar - This is a key parameter which expects to be passed a valid avatar key.

Revision as of 20:48, 24 January 2007

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

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 - this needs to be rather finalized first.)

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

This is a bunch of code enclosed between pre and blockquote tags.  ''(note: may want to use a template of some sort instead)''

default
{
  this is-a bunch(code, {pre}, enclosed, {blockquote};
}

See also

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

Notes

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