Difference between revisions of "Template:LSL Function"
Jump to navigation
Jump to search
Line 250: | Line 250: | ||
''(Please use 'return_text' or 'func_desc' to describe the functions actions.)''</div></div>{{#if:{{{self|}}}|| [[Category:LSL FixMe]] }} }} {{LSL Generic | ''(Please use 'return_text' or 'func_desc' to describe the functions actions.)''</div></div>{{#if:{{{self|}}}|| [[Category:LSL FixMe]] }} }} {{LSL Generic | ||
|{{{func}}}| | |{{{func}}}| | ||
|header_text={{LSL_Generic/Text | |||
|header_floater=<table> | |||
<tr> | |||
<td> {{HoverText|{{#ifeq:{{{mode|}}}|request|REQUEST|{{{func_id|}}}}}|The function index number.}} | |||
<td> {{LSLG|Function ID}} | |||
</tr> | |||
<tr> | |||
<td> {{HoverText|{{{func_sleep|}}}|The number of seconds this script will sleep after executing this function.}} | |||
<td> {{LSLG|Delay}} | |||
</tr> | |||
<tr> | |||
<td> {{HoverText|{{{func_energy|}}}|The quantity of energy consumed by this function.}} | |||
<td> {{LSLG|Energy}} | |||
</tr> | |||
</table> | |||
|return_type={{{return_type|}}} | |||
|return_text={{#if:{{{return_text|}}}|{{{return_text|}}}|.}} | |||
|header_desc={{{func_desc|}}} | |header_desc={{{func_desc|}}} | ||
|header_footnote={{{func_footnote|}}}{{{func_footer|}}}{{#if: {{{permission|}}}| {{#if: {{{func_footnote|}}}{{{func_footer|}}}|<br/>}}Requires the {{LSLG|{{{permission}}}}} permission to run.}}{{#if: {{{negative_index|}}}| {{#if: {{{func_footnote|}}}{{{func_footer|}}}{{{permission|}}}|<br/>}}This function {{#ifeq:{{{negative_index|}}}|false| ''does not'' support | supports }} {{LSLGC|Negative Index|neative indexes}}.}} | |header_footnote={{{func_footnote|}}}{{{func_footer|}}}{{#if: {{{permission|}}}| {{#if: {{{func_footnote|}}}{{{func_footer|}}}|<br/>}}Requires the {{LSLG|{{{permission}}}}} permission to run.}}{{#if: {{{negative_index|}}}| {{#if: {{{func_footnote|}}}{{{func_footer|}}}{{{permission|}}}|<br/>}}This function {{#ifeq:{{{negative_index|}}}|false| ''does not'' support | supports }} {{LSLGC|Negative Index|neative indexes}}.}} | ||
|p1_name={{{p1_name|}}} | |||
|p1_type={{{p1_type|}}} | |||
|p1_desc={{{p1_desc|}}} | |||
|p2_name={{{p2_name|}}} | |||
|p2_type={{{p2_type|}}} | |||
|p2_desc={{{p2_desc|}}} | |||
|p3_name={{{p3_name|}}} | |||
|p3_type={{{p3_type|}}} | |||
|p3_desc={{{p3_desc|}}} | |||
|p4_name={{{p4_name|}}} | |||
|p4_type={{{p4_type|}}} | |||
|p4_desc={{{p4_desc|}}} | |||
|p5_name={{{p5_name|}}} | |||
|p5_type={{{p5_type|}}} | |||
|p5_desc={{{p5_desc|}}} | |||
|p6_name={{{p6_name|}}} | |||
|p6_type={{{p6_type|}}} | |||
|p6_desc={{{p6_desc|}}} | |||
|p7_name={{{p7_name|}}} | |||
|p7_type={{{p7_type|}}} | |||
|p7_desc={{{p7_desc|}}} | |||
|p8_name={{{p8_name|}}} | |||
|p8_type={{{p8_type|}}} | |||
|p8_desc={{{p8_desc|}}} | |||
|p9_name={{{p9_name|}}} | |||
|p9_type={{{p9_type|}}} | |||
|p9_desc={{{p9_desc|}}} | |||
|p10_name={{{p10_name|}}} | |||
|p10_type={{{p10_type|}}} | |||
|p10_desc={{{p10_desc|}}} | |||
|p11_name={{{p11_name|}}} | |||
|p11_type={{{p11_type|}}} | |||
|p11_desc={{{p11_desc|}}} | |||
|p12_name={{{p12_name|}}} | |||
|p12_type={{{p12_type|}}} | |||
|p12_desc={{{p12_desc|}}}}} | |||
|header_title | |||
|deprecated={{{deprecated|}}}{{{depreciated|}}} | |deprecated={{{deprecated|}}}{{{depreciated|}}} | ||
|constants_nb={{{constants|}}} | |constants_nb={{{constants|}}} | ||
|spec={{{spec|}}} | |spec={{{spec|}}} | ||
Line 295: | Line 335: | ||
|template=LSLG | |template=LSLG | ||
|footer={{#ifeq:{{{mode|}}}|request||{{#if:{{{no_footer|}}}||:<div style="font-size:x-small;">This page is based on information gathered from the Second Life client {{HoverText|source|'linden\indra\lscript\lscript_library\lscript_library.cpp'}}, and as such has additional [http://secondlife.com/developers/opensource/licenses licensing restrictions].</div>}}}} | |footer={{#ifeq:{{{mode|}}}|request||{{#if:{{{no_footer|}}}||:<div style="font-size:x-small;">This page is based on information gathered from the Second Life client {{HoverText|source|'linden\indra\lscript\lscript_library\lscript_library.cpp'}}, and as such has additional [http://secondlife.com/developers/opensource/licenses licensing restrictions].</div>}}}} | ||
}}{{#if:{{{self|}}}|| {{#ifeq:{{{mode|}}}|request|| {{#if:{{{sort|}}}|[[Category:LSL Functions|{{{sort|}}}]]}} {{#if: {{{permission|}}}|{{LSLC|Requires Permissions|{{{sort|}}}}}}} {{#ifeq:{{{negative_index|}}}|true|{{LSLC|Negative Index|{{{sort|}}}}}}}}} {{#if:{{{cat1|}}}|{{LSLC|{{{cat1}}}|{{{sort|}}}}}}} {{#if:{{{cat2|}}}|{{LSLC|{{{cat2}}}|{{{sort|}}}}}}} {{#if:{{{cat3|}}}|{{LSLC|{{{cat3}}}|{{{sort|}}}}}}} {{#if:{{{cat4|}}}|{{LSLC|{{{cat4}}}|{{{sort|}}}}}}}}}</includeonly> | }}{{#if:{{{self|}}}|| {{#ifeq:{{{mode|}}}|request|| {{#if:{{{sort|}}}|[[Category:LSL Functions|{{{sort|}}}]]}} {{#if: {{{permission|}}}|{{LSLC|Requires Permissions|{{{sort|}}}}}}} {{#ifeq:{{{negative_index|}}}|true|{{LSLC|Negative Index|{{{sort|}}}}}}}}} {{#if:{{{cat1|}}}|{{LSLC|{{{cat1}}}|{{{sort|}}}}}}} {{#if:{{{cat2|}}}|{{LSLC|{{{cat2}}}|{{{sort|}}}}}}} {{#if:{{{cat3|}}}|{{LSLC|{{{cat3}}}|{{{sort|}}}}}}} {{#if:{{{cat4|}}}|{{LSLC|{{{cat4}}}|{{{sort|}}}}}}}}}</includeonly> |
Revision as of 09:28, 8 February 2007
LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
{{LSL_Function |func |func_id |func_sleep |func_desc |func_footnote |return_type |return_text |p1_type|p1_name|p1_desc |p2_type|p2_name|p2_desc |p3_type|p3_name|p3_desc |p4_type|p4_name|p4_desc |p5_type|p5_name|p5_desc |p6_type|p6_name|p6_desc |p7_type|p7_name|p7_desc |p8_type|p8_name|p8_desc |p9_type|p9_name|p9_desc |p10_type|p10_name|p10_desc |p11_type|p11_name|p11_desc |p12_type|p12_name|p12_desc |constants |spec |caveats |examples |helpers |also_header |also_functions |also_tests |also_articles |also_footer |notes |mode |deprecated |sort |permission |negative_index |cat1 |cat2 |cat3 |cat4 }}
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 and set the additional copyright message. 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_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. | |
sort | The sort value for use with categories. | GetTime |
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 | " |
LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
Examples