Difference between revisions of "Template:LSL Function"
Jump to navigation
Jump to search
m (style) |
|||
Line 12: | Line 12: | ||
|return_type | |return_type | ||
|return_text | |return_text | ||
|p1_type|p1_name|p1_desc | |p1_type|p1_name|p1_desc|p1_hover | ||
|p2_type|p2_name|p2_desc | |p2_type|p2_name|p2_desc|p2_hover | ||
|p3_type|p3_name|p3_desc | |p3_type|p3_name|p3_desc|p3_hover | ||
|p4_type|p4_name|p4_desc | |p4_type|p4_name|p4_desc|p4_hover | ||
|p5_type|p5_name|p5_desc | |p5_type|p5_name|p5_desc|p5_hover | ||
|p6_type|p6_name|p6_desc | |p6_type|p6_name|p6_desc|p6_hover | ||
|p7_type|p7_name|p7_desc | |p7_type|p7_name|p7_desc|p7_hover | ||
|p8_type|p8_name|p8_desc | |p8_type|p8_name|p8_desc|p8_hover | ||
|p9_type|p9_name|p9_desc | |p9_type|p9_name|p9_desc|p9_hover | ||
|p10_type|p10_name|p10_desc | |p10_type|p10_name|p10_desc|p10_hover | ||
|p11_type|p11_name|p11_desc | |p11_type|p11_name|p11_desc|p11_hover | ||
|p12_type|p12_name|p12_desc | |p12_type|p12_name|p12_desc|p12_hover | ||
|constants | |constants | ||
|spec | |spec | ||
Line 259: | Line 259: | ||
{{#vardefine:history|{{{history|}}}}} | {{#vardefine:history|{{{history|}}}}} | ||
{{#vardefine:func_id|{{{func_id|}}}}} | {{#vardefine:func_id|{{{func_id|}}}}} | ||
{{#vardefine:p1_name|{{{p1_name|}}}}}{{#vardefine:p1_type|{{{p1_type|}}}}}{{#vardefine:p_{{#var:p1_name}}_desc|{{#var:p_{{#var:p1_name}}_desc}}{{{p1_desc|}}}}} | {{#vardefine:p1_name|{{{p1_name|}}}}}{{#vardefine:p1_type|{{{p1_type|}}}}} | ||
{{#vardefine:p2_name|{{{p2_name|}}}}}{{#vardefine:p2_type|{{{p2_type|}}}}}{{#vardefine:p_{{#var:p2_name}}_desc|{{#var:p_{{#var:p2_name}}_desc}}{{{p2_desc|}}}}} | {{#vardefine:p_{{#var:p1_name}}_desc|{{#var:p_{{#var:p1_name}}_desc}}{{{p1_desc|}}}}} | ||
{{#vardefine:p3_name|{{{p3_name|}}}}}{{#vardefine:p3_type|{{{p3_type|}}}}}{{#vardefine:p_{{#var:p3_name}}_desc|{{#var:p_{{#var:p3_name}}_desc}}{{{p3_desc|}}}}} | {{#vardefine:p_{{#var:p1_name}}_hover|{{#var:p_{{#var:p1_name}}_hover}}{{{p1_hover|}}}}} | ||
{{#vardefine:p4_name|{{{p4_name|}}}}}{{#vardefine:p4_type|{{{p4_type|}}}}}{{#vardefine:p_{{#var:p4_name}}_desc|{{#var:p_{{#var:p4_name}}_desc}}{{{p4_desc|}}}}} | {{#vardefine:p2_name|{{{p2_name|}}}}}{{#vardefine:p2_type|{{{p2_type|}}}}} | ||
{{#vardefine:p5_name|{{{p5_name|}}}}}{{#vardefine:p5_type|{{{p5_type|}}}}}{{#vardefine:p_{{#var:p5_name}}_desc|{{#var:p_{{#var:p5_name}}_desc}}{{{p5_desc|}}}}} | {{#vardefine:p_{{#var:p2_name}}_desc|{{#var:p_{{#var:p2_name}}_desc}}{{{p2_desc|}}}}} | ||
{{#vardefine:p6_name|{{{p6_name|}}}}}{{#vardefine:p6_type|{{{p6_type|}}}}}{{#vardefine:p_{{#var:p6_name}}_desc|{{#var:p_{{#var:p6_name}}_desc}}{{{p6_desc|}}}}} | {{#vardefine:p_{{#var:p2_name}}_hover|{{#var:p_{{#var:p2_name}}_hover}}{{{p2_hover|}}}}} | ||
{{#vardefine:p7_name|{{{p7_name|}}}}}{{#vardefine:p7_type|{{{p7_type|}}}}}{{#vardefine:p_{{#var:p7_name}}_desc|{{#var:p_{{#var:p7_name}}_desc}}{{{p7_desc|}}}}} | {{#vardefine:p3_name|{{{p3_name|}}}}}{{#vardefine:p3_type|{{{p3_type|}}}}} | ||
{{#vardefine:p8_name|{{{p8_name|}}}}}{{#vardefine:p8_type|{{{p8_type|}}}}}{{#vardefine:p_{{#var:p8_name}}_desc|{{#var:p_{{#var:p8_name}}_desc}}{{{p8_desc|}}}}} | {{#vardefine:p_{{#var:p3_name}}_desc|{{#var:p_{{#var:p3_name}}_desc}}{{{p3_desc|}}}}} | ||
{{#vardefine:p9_name|{{{p9_name|}}}}}{{#vardefine:p9_type|{{{p9_type|}}}}}{{#vardefine:p_{{#var:p9_name}}_desc|{{#var:p_{{#var:p9_name}}_desc}}{{{p9_desc|}}}}} | {{#vardefine:p_{{#var:p3_name}}_hover|{{#var:p_{{#var:p3_name}}_hover}}{{{p3_hover|}}}}} | ||
{{#vardefine:p10_name|{{{p10_name|}}}}}{{#vardefine:p10_type|{{{p10_type|}}}}}{{#vardefine:p_{{#var:p10_name}}_desc|{{#var:p_{{#var:p10_name}}_desc}}{{{p10_desc|}}}}} | {{#vardefine:p4_name|{{{p4_name|}}}}}{{#vardefine:p4_type|{{{p4_type|}}}}} | ||
{{#vardefine:p11_name|{{{p11_name|}}}}}{{#vardefine:p11_type|{{{p11_type|}}}}}{{#vardefine:p_{{#var:p11_name}}_desc|{{#var:p_{{#var:p11_name}}_desc}}{{{p11_desc|}}}}} | {{#vardefine:p_{{#var:p4_name}}_desc|{{#var:p_{{#var:p4_name}}_desc}}{{{p4_desc|}}}}} | ||
{{#vardefine:p12_name|{{{p12_name|}}}}}{{#vardefine:p12_type|{{{p12_type|}}}}}{{#vardefine:p_{{#var:p12_name}}_desc|{{#var:p_{{#var:p12_name}}_desc}}{{{p12_desc|}}}}} | {{#vardefine:p_{{#var:p4_name}}_hover|{{#var:p_{{#var:p4_name}}_hover}}{{{p4_hover|}}}}} | ||
{{#vardefine:p5_name|{{{p5_name|}}}}}{{#vardefine:p5_type|{{{p5_type|}}}}} | |||
{{#vardefine:p_{{#var:p5_name}}_desc|{{#var:p_{{#var:p5_name}}_desc}}{{{p5_desc|}}}}} | |||
{{#vardefine:p_{{#var:p5_name}}_hover|{{#var:p_{{#var:p5_name}}_hover}}{{{p5_hover|}}}}} | |||
{{#vardefine:p6_name|{{{p6_name|}}}}}{{#vardefine:p6_type|{{{p6_type|}}}}} | |||
{{#vardefine:p_{{#var:p6_name}}_desc|{{#var:p_{{#var:p6_name}}_desc}}{{{p6_desc|}}}}} | |||
{{#vardefine:p_{{#var:p6_name}}_hover|{{#var:p_{{#var:p6_name}}_hover}}{{{p6_hover|}}}}} | |||
{{#vardefine:p7_name|{{{p7_name|}}}}}{{#vardefine:p7_type|{{{p7_type|}}}}} | |||
{{#vardefine:p_{{#var:p7_name}}_desc|{{#var:p_{{#var:p7_name}}_desc}}{{{p7_desc|}}}}} | |||
{{#vardefine:p_{{#var:p7_name}}_hover|{{#var:p_{{#var:p7_name}}_hover}}{{{p7_hover|}}}}} | |||
{{#vardefine:p8_name|{{{p8_name|}}}}}{{#vardefine:p8_type|{{{p8_type|}}}}} | |||
{{#vardefine:p_{{#var:p8_name}}_desc|{{#var:p_{{#var:p8_name}}_desc}}{{{p8_desc|}}}}} | |||
{{#vardefine:p_{{#var:p8_name}}_hover|{{#var:p_{{#var:p8_name}}_hover}}{{{p8_hover|}}}}} | |||
{{#vardefine:p9_name|{{{p9_name|}}}}}{{#vardefine:p9_type|{{{p9_type|}}}}} | |||
{{#vardefine:p_{{#var:p9_name}}_desc|{{#var:p_{{#var:p9_name}}_desc}}{{{p9_desc|}}}}} | |||
{{#vardefine:p_{{#var:p9_name}}_hover|{{#var:p_{{#var:p9_name}}_hover}}{{{p9_hover|}}}}} | |||
{{#vardefine:p10_name|{{{p10_name|}}}}}{{#vardefine:p10_type|{{{p10_type|}}}}} | |||
{{#vardefine:p_{{#var:p10_name}}_desc|{{#var:p_{{#var:p10_name}}_desc}}{{{p10_desc|}}}}} | |||
{{#vardefine:p_{{#var:p10_name}}_hover|{{#var:p_{{#var:p10_name}}_hover}}{{{p10_hover|}}}}} | |||
{{#vardefine:p11_name|{{{p11_name|}}}}}{{#vardefine:p11_type|{{{p11_type|}}}}} | |||
{{#vardefine:p_{{#var:p11_name}}_desc|{{#var:p_{{#var:p11_name}}_desc}}{{{p11_desc|}}}}} | |||
{{#vardefine:p_{{#var:p11_name}}_hover|{{#var:p_{{#var:p11_name}}_hover}}{{{p11_hover|}}}}} | |||
{{#vardefine:p12_name|{{{p12_name|}}}}}{{#vardefine:p12_type|{{{p12_type|}}}}} | |||
{{#vardefine:p_{{#var:p12_name}}_desc|{{#var:p_{{#var:p12_name}}_desc}}{{{p12_desc|}}}}} | |||
{{#vardefine:p_{{#var:p12_name}}_hover|{{#var:p_{{#var:p12_name}}_hover}}{{{p12_hover|}}}}} | |||
{{#vardefine:return_type|{{#var:return_type}}{{{return_type|}}} }} | {{#vardefine:return_type|{{#var:return_type}}{{{return_type|}}} }} | ||
{{#vardefine:return_text|{{#var:return_text}}{{{return_text|}}} }} | {{#vardefine:return_text|{{#var:return_text}}{{{return_text|}}} }} |
Revision as of 16:21, 14 July 2007
LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
See Template:LSL Function/docs for additional documentation.
{{LSL_Function |func |func_id |func_sleep |func_energy |sort |func_desc |func_footnote |return_type |return_text |p1_type|p1_name|p1_desc|p1_hover |p2_type|p2_name|p2_desc|p2_hover |p3_type|p3_name|p3_desc|p3_hover |p4_type|p4_name|p4_desc|p4_hover |p5_type|p5_name|p5_desc|p5_hover |p6_type|p6_name|p6_desc|p6_hover |p7_type|p7_name|p7_desc|p7_hover |p8_type|p8_name|p8_desc|p8_hover |p9_type|p9_name|p9_desc|p9_hover |p10_type|p10_name|p10_desc|p10_hover |p11_type|p11_name|p11_desc|p11_hover |p12_type|p12_name|p12_desc|p12_hover |constants |spec |caveats |examples |helpers |also_header |also_functions |also_tests |also_events |also_articles |also_footer |notes |mode |deprecated |location |inventory |permission |negative_index |cat1 |cat2 |cat3 |cat4 |cat5 |cat6 }}
The LSL_Function template is a intermediate template for LSL_Generic, which handles the formating for both functions and events (LSL_Event is also an intermediate template). The main job of this template is to change the parameter, names & setup the right-side floater. Also makes permission requirements a part of the template.
parameter | desc | example |
---|---|---|
func | Function name | |
func_id | Function ID | 1.0 |
func_sleep | Delay | 0.0 |
func_energy | Energy | 10.0 |
func_desc | Function description text. | Gives the monkey a banana |
func_footnote | Function footnote (appears after the parameters text). | Has the side effect of causing the avatar to run in circles shouting like on fire. |
return_type | return type | integer |
return_text | "Returns a return_type return_text" in most cases return_text can be used instead of func_desc. | that is a monkey |
p1_type | first parameter type | |
p1_name | first parameter name | |
p1_desc | first parameter desc | |
p2_type | second parameter type | |
p2_name | second parameter name | |
p2_desc | second parameter desc | |
... | ||
p12_type | twelfth parameter type | |
p12_name | twelfth parameter name | |
p12_desc | twelfth parameter desc | |
constants | constants area, no box, please use a table for this section. | |
spec | spec box | |
caveats | caveats box | |
examples | examples box | |
helpers | helper functions box | |
also_header | also header | |
also_functions | also functions indent | |
also_events | also events indent | |
also_articles | also articles indent | |
also_tests | also tests indent | |
also_footer | also footer | |
notes | notes box | |
mode | if mode equals 'god' then it is tagged as requiring godmode. if set to 'request' marks the page as a feature request. | |
deprecated | Marks the function as deprecated. Set the value to the replacement functions name or 'none'. If it is not set to none and it is infact set, it will include a link to the replacement function. | |
permission | Set to the PERMISSION_* flag that the function requires. It will amend the appropriate fields to show this requirement (without all the haste of doing it yourself) | PERMISSION_CHANGE_LINKS |
negative_index | 'true', 'false' or nothing. If set to true or false then it amends the appropriate fields so that the function is marked as supporting or not supporting negative indexes. | true |
self | Special field that you only set if you don't want the function to be included in any categories. | |
cat1 | An LSL specific category and sets the proper sort. (example would add the function to the "LSL Stub" category) | Stub |
cat2 | " | |
cat3 | " | |
cat4 | " | |
cat5 | " | |
cat6 | " | |
sort | not required but used to specify the sort order, if excluded the wiki will calculate this value for you. | |
location | optional: location box, used to say which source file it is defined in. | |
inventory | set to the name of the parameter that is an inventory item name. It makes a nice message in caveats about missing inventory items. | |
history | a box for function history |
LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
Specificationspec | ||||
constants | ||||
Caveats
caveats | ||||
Examplesexamples | ||||
Useful Snippetshelpers | ||||
Notesnotes | ||||
See Also
also_header Events
Functions
Tests
Articles
| ||||
Source Locationlocation | ||||
Historyhistory |