Difference between revisions of "LSL Function Style"

From Second Life Wiki
Jump to navigation Jump to search
m (rm extraneous space)
Line 1: Line 1:
  {{lowercase|llFunction}}
  {{lowercase|llFunction}}
__NOTOC__
__NOTOC__
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)
<div id="box" style="background:#ffdead;">
 
&nbsp;&nbsp;'''WORK IN PROGRESS'''
<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 presumed to be not finalized yet - this needs to be rather finalized first.)''
</div>
</div>


==Syntax==
{| width="100%"
integer llFunction(key avatar, integer widgets, float stickLength);
|-
 
|valign="top"|
<div id="box">
<div style="padding: 0.5em">
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)
</div>
</div>
|-
|<div id="box">
== [[integer]] llFunction([[key]] avatar, [[integer]] widgets, [[float]] stickLength); ==
<div style="padding: 0.5em">
* 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.
* widgets - This is an integer parameter which indicates the number of widgets to process.
* 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.
* stickLength - This is a float parameter used to describe the length of the stick used to whack bad formatters.
 
</div>
==Specification==
</div>
|-
|
<div id="box">
== Specification ==
<div style="padding: 0.5em">
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.
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.
 
</div>
==Caveats==
</div>
|-
|
<div id="box">
== Caveats ==
<div style="padding: 0.5em">
* Don't use this function to test whether a key is null.
* Don't use this function to test whether a key is null.
* ''(if you know of none, try using:)'' None known
* ''(if you know of none, try using:)'' None known
</div>
</div>


==Examples==
|-
<blockquote><pre>
|
This is a bunch of code enclosed between pre and blockquote tags.  ''(note: may want to use a template of some sort instead)''
<div id="box">
 
== Examples ==
<div style="padding: 0.5em">
<lsl>
default
default
{
{
  this is-a bunch(code, {pre}, enclosed, {blockquote};
    state_entry()
    {
        llSay(0,"The absolute value of -4 is: "+(string)llAbs(-4) );
    }
}
}
</lsl>


</pre></blockquote>
</div>
 
</div>
==See also==
|-
|
<div id="box">
== See Also ==
<div style="padding: 0.5em">
(similar functions, related examples and pages, etc.)
(similar functions, related examples and pages, etc.)


==Notes==
</div>
</div>
|-
|
<div id="box">
== Notes ==
<div style="padding: 0.5em">
(footnotes, if necessary - caveats should go in caveats section)
(footnotes, if necessary - caveats should go in caveats section)
</div>
</div>
|}

Revision as of 22:26, 24 January 2007

The correct title of this article is 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)

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

<lsl> default {

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

} </lsl>

See Also

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

Notes

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