Difference between revisions of "LSL Function Style"

From Second Life Wiki
Jump to navigation Jump to search
({{lowercase}}, better formatting for examples)
m
 
(36 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{lowercase|llFunction}}
{{LSL Header|ml=*}} __NOTOC__
Propose a style for the LSL function articles by creating an article in the following form: <nowiki>[[{{FULLPAGENAME}}/Your Resident name]]</nowiki>


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)
General discussion should be held in [[Talk:LSL Function Style]], whereas questions regarding a specific implementation should be held in the relevant article's talk page.


''(This style and layout is presumed to be not finalized yet - this needs to be rather finalized first.)''
== Requirements ==
* Allows for accurate documentation
* Easy accessible to new and old scripters alike
* Details common problems with solutions


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


* avatar - This is a key parameter which expects to be passed a valid avatar key.
=== Round 1 ===
* widgets - This is an integer parameter which indicates the number of widgets to process.
* [[{{PAGENAME}}/Celierra Darling|Celierra Darling]]
* stickLength - This is a float parameter used to describe the length of the stick used to whack bad formatters.
* [[{{PAGENAME}}/Strife Onizuka|Strife Onizuka ''et al.'']]
* [[{{PAGENAME}}/SignpostMarv Martin|SignpostMarv Martin]]


==Specification==
=== Round 2 ===
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.
* [[User:Strife_Onizuka/LSL_Style|Strife Onizuka]] - tentative submission
 
==Caveats==
* Don't use this function to test whether a key is null.
* ''(if you know of none, try using:)'' None known
 
==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)''
 
default
{
  this is-a bunch(code, {pre}, enclosed, {blockquote};
}
 
</pre></blockquote>
 
==See also==
(similar functions, related examples and pages, etc.)
 
==Notes==
(footnotes, if necessary - caveats should go in caveats section)

Latest revision as of 15:36, 24 October 2008