Difference between revisions of "LSL Function Style/Celierra Darling"
Jump to navigation
Jump to search
(fix some) |
(more additions) |
||
| Line 1: | Line 1: | ||
<!-- | |||
CSS for the infobox class | |||
.infobox { | .infobox { | ||
border: 1px solid #aaa; | border: 1px solid #aaa; | ||
| Line 37: | Line 39: | ||
--> | --> | ||
<!-- Infobox begin --> | <!-- Infobox begin (float:right and clear:right manually added due to lack of infobox CSS class) --> | ||
{| class="infobox" style="width: 20em; font-size: 95%; border-collapse: collapse; margin:0 0 1em 1em; float: right; clear: right" cellspacing="0" cellpadding="2" | {| class="infobox" style="width: 20em; font-size: 95%; border-collapse: collapse; margin:0 0 1em 1em; float: right; clear: right" cellspacing="0" cellpadding="2" | ||
|+ style="font-size: larger;" | '''llExample''' | |+ style="font-size: larger;" | '''llExample''' | ||
| Line 54: | Line 56: | ||
| pokes | | pokes | ||
<!-- Middle params --> | <!-- Middle params --> | ||
|- | |- style="background-color:#F0F0F0" | ||
| style="text-align: right" | [[string]] | |||
| descriptiveName | |||
|- style="background-color:#F0F0F0" | |||
| style="text-align: right" | [[list]] | | style="text-align: right" | [[list]] | ||
| | | parameterList | ||
|- style="background-color:#F0F0F0" | |- style="background-color:#F0F0F0" | ||
| style="text-align: right" | [[key]] | | style="text-align: right" | [[key]] | ||
| Line 75: | Line 80: | ||
| -1 | | -1 | ||
<!-- dependencies --> | <!-- dependencies --> | ||
|- style="background-color:#F0F0F0; border-top:1px solid #AAAAAA;" | |||
| colspan="2" | '''Works with:''' | |||
|- style="background-color:#F0F0F0" | |- style="background-color:#F0F0F0" | ||
| colspan="2" | [[llListen]] | | colspan="2" | [[llListen]], [[llListenRemove]], [[llListenControl]] (example for listen()) | ||
|- | |- | ||
<!-- infobox end --> | <!-- infobox end --> | ||
|} | |} | ||
'''This page is in progress and nowhere near done yet''' | |||
This is the lede and should give a short overview of the function. This [[LSL]] [[function]] takes in a number of pokes, a name for the animation, a list of parameters (see [[#Parameter_list|below table]]), the key of an avatar, and the position from which the giant hand should appear. It caused the specified damaged to be poked repeatedly, for massive damage. | |||
Todo: | Todo: | ||
* Finish everything | * Finish everything | ||
* Templatize | * Templatize | ||
* Make sample text for a real function | |||
* Add cool things like | * Add cool things like | ||
** Detection of incomplete infoboxes | ** Detection of incomplete infoboxes | ||
** | ** More modularity | ||
== Specification == | == Specification == | ||
The exact behavior of the function, its preconditions, postconditions, etc. | |||
Ex. Channel number must be between x and y. Channel 0 is main, everyone can hear. Negatives are okay. | |||
== Caveats == | === Parameter list === | ||
A table would go here. | |||
=== Caveats === | |||
Common misunderstandings, mistakes, etc. | |||
* Listens are removed when changing state | |||
* The function returns a handle that should be used to manually remove the listen | |||
* Causes lag if you listen too many | |||
* Max number | |||
* etc. | |||
== Examples == | == Examples == | ||
Short examples, blah blah, should try to demonstrate all the caveats, though not necessarily in one script. Maybe some creative uses. | |||
== Notes == | == Notes == | ||
Anything obscure that isn't covered above. | |||
== Internal == | == Internal == | ||
Design document, functional spec, test scripts, related functions - for LL use, mostly (see how they did [[llEmail]]). | |||
Design document, functional spec, test scripts, related functions | |||
== See Also == | == See Also == | ||
* [[listen]] | |||
* etc. | |||
Revision as of 10:52, 16 February 2007
| Returns: | |
| boolean | success |
| Parameters: | |
| integer | pokes |
| string | descriptiveName |
| list | parameterList |
| key | target |
| vector | position |
| Delay | 0 |
| Energy | 10 |
| Function ID | -1 |
| Works with: | |
| llListen, llListenRemove, llListenControl (example for listen()) | |
This page is in progress and nowhere near done yet
This is the lede and should give a short overview of the function. This LSL function takes in a number of pokes, a name for the animation, a list of parameters (see below table), the key of an avatar, and the position from which the giant hand should appear. It caused the specified damaged to be poked repeatedly, for massive damage.
Todo:
- Finish everything
- Templatize
- Make sample text for a real function
- Add cool things like
- Detection of incomplete infoboxes
- More modularity
Specification
The exact behavior of the function, its preconditions, postconditions, etc.
Ex. Channel number must be between x and y. Channel 0 is main, everyone can hear. Negatives are okay.
Parameter list
A table would go here.
Caveats
Common misunderstandings, mistakes, etc.
- Listens are removed when changing state
- The function returns a handle that should be used to manually remove the listen
- Causes lag if you listen too many
- Max number
- etc.
Examples
Short examples, blah blah, should try to demonstrate all the caveats, though not necessarily in one script. Maybe some creative uses.
Notes
Anything obscure that isn't covered above.
Internal
Design document, functional spec, test scripts, related functions - for LL use, mostly (see how they did llEmail).
See Also
- listen
- etc.