Difference between revisions of "Template:LSL Function"
Jump to navigation
Jump to search
(this shouldn't have any negative effects but just in case... please look out for any.) |
(Drop obsolete function id) |
||
(75 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
{{Multi-lang|category=LSL}}{{LSL Header{{#var:lang}}}} __NOTOC__ <noinclude> | {{Multi-lang|category=LSL|2=}}{{LSL Header{{#var:lang}}}} __NOTOC__ <noinclude> | ||
See [[{{#var:langbase}}/docs{{#var:lang}}]] for documentation. | See [[{{#var:langbase}}/docs{{#var:lang}}]] for documentation. | ||
</noinclude><includeonly>{{#if:{{ | </noinclude><includeonly>{{DISPLAYTITLE:{{#if:{{NAMESPACE}}|{{NAMESPACE}}:}}{{lcfirst:{{PAGENAME}}}}}}<!-- | ||
I have no idea if the following is still used or I am misunderstanding it. Keeping it for now. -->{{#if:{{#var:sort}}||{{#if:{{{sort|}}}|{{#vardefine:sort|{{{sort|}}}}}|{{#if:{{LSL_Sort}}}}}}}}<div id="sort" style="display:none">{{DEFAULTSORT:{{#var:sort}}}}{{#var:sort}}</div>{{#if:{{#var:nofixname}}||{{#if:{{#pos:{{lc:{{FULLPAGENAMEE}}}}|{{lc:{{{func}}}}}}}|<div id="RealTitleBanner" style="display:none"><span id="RealTitle">{{#if:{{NAMESPACE}}|{{NAMESPACE}}:}}{{{func}}}</span></div>}}}}{{#if: | |||
{{#vardefine:article_type|function}} | {{#vardefine:article_type|function}} | ||
{{#vardefine:func_id|{{{func_id|}}}}} | |||
{{#vardefine:name|{{{func|}}}}} | |||
{{#if:{{{func_id|}}}|{{#vardefine:func_id|{{{func_id|}}}}}|{{#if:{{#var:func_id}}||{{#vardefine:func_id|?}}}}}} | |||
{{#vardefine:mode|{{#var:mode}}{{{mode|}}}}} | {{#vardefine:mode|{{#var:mode}}{{{mode|}}}}} | ||
{{#vardefine:self|{{#var:self}}{{{self|}}}}} | {{#vardefine:self|{{#var:self}}{{{self|}}}}} | ||
{{{inject-1|}}} | |||
{{{{#switch:{{#var:mode}} | {{{{#switch:{{#var:mode}} | ||
Line 12: | Line 18: | ||
|request=LSL_Generic/request{{#var:lang}} | |request=LSL_Generic/request{{#var:lang}} | ||
|pre-release=LSL_Generic/pre-release{{#var:lang}} | |pre-release=LSL_Generic/pre-release{{#var:lang}} | ||
|rc=LSL_Generic/RC{{#var:lang}} | |||
|preview=LSL_Generic/preview{{#var:lang}} | |preview=LSL_Generic/preview{{#var:lang}} | ||
|!}}|}} | |user=!{{#vardefine:moded|u{{#var:moded}}}} | ||
|!}}|text={{{mode_text|}}}}} | |||
{{{{#if:{{{deprecated|}}}|LSL_Generic/deprecated{{#var:lang}}|!}}|{{{deprecated|}}}|}} | {{{{#if:{{{deprecated|}}}|LSL_Generic/deprecated{{#var:lang}}|!}}|{{{deprecated|}}}|}} | ||
{{{inject-2|}}} | |||
{{#vardefine:p_{{{p1_name|}}}_hover|{{#var:p_{{{p1_name|}}}_hover}}{{{p1_hover|}}}}} | |||
{{#vardefine:p_{{{p2_name|}}}_hover|{{#var:p_{{{p2_name|}}}_hover}}{{{p2_hover|}}}}} | |||
{{#vardefine:p_{{{p3_name|}}}_hover|{{#var:p_{{{p3_name|}}}_hover}}{{{p3_hover|}}}}} | |||
{{#vardefine:p_{{{p4_name|}}}_hover|{{#var:p_{{{p4_name|}}}_hover}}{{{p4_hover|}}}}} | |||
{{#vardefine:p_{{{p5_name|}}}_hover|{{#var:p_{{{p5_name|}}}_hover}}{{{p5_hover|}}}}} | |||
{{#vardefine:p_{{{p6_name|}}}_hover|{{#var:p_{{{p6_name|}}}_hover}}{{{p6_hover|}}}}} | |||
{{#vardefine:p_{{{p7_name|}}}_hover|{{#var:p_{{{p7_name|}}}_hover}}{{{p7_hover|}}}}} | |||
{{#vardefine:p_{{{p8_name|}}}_hover|{{#var:p_{{{p8_name|}}}_hover}}{{{p8_hover|}}}}} | |||
{{#vardefine:p_{{{p9_name|}}}_hover|{{#var:p_{{{p9_name|}}}_hover}}{{{p9_hover|}}}}} | |||
{{#vardefine:p_{{{p10_name|}}}_hover|{{#var:p_{{{p10_name|}}}_hover}}{{{p10_hover|}}}}} | |||
{{#vardefine:p_{{{p11_name|}}}_hover|{{#var:p_{{{p11_name|}}}_hover}}{{{p11_hover|}}}}} | |||
{{#vardefine:p_{{{p12_name|}}}_hover|{{#var:p_{{{p12_name|}}}_hover}}{{{p12_hover|}}}}} | |||
{{#vardefine:p_{{{p1_name|}}}_desc|{{#var:p_{{{p1_name|}}}_desc}}{{{p1_desc|}}}}} | {{#vardefine:p_{{{p1_name|}}}_desc|{{#var:p_{{{p1_name|}}}_desc}}{{{p1_desc|}}}}} | ||
{{#vardefine:p_{{{p2_name|}}}_desc|{{#var:p_{{{p2_name|}}}_desc}}{{{p2_desc|}}}}} | {{#vardefine:p_{{{p2_name|}}}_desc|{{#var:p_{{{p2_name|}}}_desc}}{{{p2_desc|}}}}} | ||
{{#vardefine:p_{{{p3_name|}}}_desc|{{#var:p_{{{p3_name|}}}_desc}}{{{p3_desc|}}}}} | {{#vardefine:p_{{{p3_name|}}}_desc|{{#var:p_{{{p3_name|}}}_desc}}{{{p3_desc|}}}}} | ||
{{#vardefine:p_{{{p4_name|}}}_desc|{{#var:p_{{{p4_name|}}}_desc}}{{{p4_desc|}}}}} | {{#vardefine:p_{{{p4_name|}}}_desc|{{#var:p_{{{p4_name|}}}_desc}}{{{p4_desc|}}}}} | ||
{{#vardefine:p_{{{p5_name|}}}_desc|{{#var:p_{{{p5_name|}}}_desc}}{{{p5_desc|}}}}} | {{#vardefine:p_{{{p5_name|}}}_desc|{{#var:p_{{{p5_name|}}}_desc}}{{{p5_desc|}}}}} | ||
{{#vardefine:p_{{{p6_name|}}}_desc|{{#var:p_{{{p6_name|}}}_desc}}{{{p6_desc|}}}}} | {{#vardefine:p_{{{p6_name|}}}_desc|{{#var:p_{{{p6_name|}}}_desc}}{{{p6_desc|}}}}} | ||
{{#vardefine:p_{{{p7_name|}}}_desc|{{#var:p_{{{p7_name|}}}_desc}}{{{p7_desc|}}}}} | {{#vardefine:p_{{{p7_name|}}}_desc|{{#var:p_{{{p7_name|}}}_desc}}{{{p7_desc|}}}}} | ||
{{#vardefine:p_{{{p8_name|}}}_desc|{{#var:p_{{{p8_name|}}}_desc}}{{{p8_desc|}}}}} | {{#vardefine:p_{{{p8_name|}}}_desc|{{#var:p_{{{p8_name|}}}_desc}}{{{p8_desc|}}}}} | ||
{{#vardefine:p_{{{p9_name|}}}_desc|{{#var:p_{{{p9_name|}}}_desc}}{{{p9_desc|}}}}} | {{#vardefine:p_{{{p9_name|}}}_desc|{{#var:p_{{{p9_name|}}}_desc}}{{{p9_desc|}}}}} | ||
{{#vardefine:p_{{{p10_name|}}}_desc|{{#var:p_{{{p10_name|}}}_desc}}{{{p10_desc|}}}}} | {{#vardefine:p_{{{p10_name|}}}_desc|{{#var:p_{{{p10_name|}}}_desc}}{{{p10_desc|}}}}} | ||
{{#vardefine:p_{{{p11_name|}}}_desc|{{#var:p_{{{p11_name|}}}_desc}}{{{p11_desc|}}}}} | {{#vardefine:p_{{{p11_name|}}}_desc|{{#var:p_{{{p11_name|}}}_desc}}{{{p11_desc|}}}}} | ||
{{#vardefine:p_{{{p12_name|}}}_desc|{{#var:p_{{{p12_name|}}}_desc}}{{{p12_desc|}}}}} | {{#vardefine:p_{{{p12_name|}}}_desc|{{#var:p_{{{p12_name|}}}_desc}}{{{p12_desc|}}}}} | ||
{{#vardefine:PBR|{{# | {{{inject-3|}}} | ||
{{#vardefine:header_footnote|{{#var:header_footnote}}{{ | |||
{{{func_footnote|}}}{{ | {{#if:{{#var:header_desc}}{{{func_desc|}}}| | ||
{{{func_footer|}}}{{#var:PBR}}}} | {{#vardefine:header_desc|{{#var:header_desc}}{{PBR}} | ||
{{{func_desc|}}}{{PBR}}}} | |||
}} | |||
{{#vardefine:return_text|{{#var:return_text}}{{{return_text|}}}{{{Return_text|}}}{{{Returns_text|}}}{{{returns_text|}}} }} | |||
{{#if:{{#var:header_footnote}}{{{func_footnote|}}}{{{func_footer|}}}| | |||
{{#vardefine:header_footnote|{{#var:header_footnote}}{{PBR}} | |||
{{{func_footnote|}}}{{PBR}} | |||
{{{func_footer|}}}{{PBR}} | |||
{{#var:header_footnote_last}}{{PBR}}}} | |||
}} | |||
{{# | {{#if:{{{other_languages|}}}| | ||
{{#vardefine:other_languages|{{LSL_Other_Languages|{{{other_languages|}}}}}}} | |||
}} | |||
{{# | {{#if:{{#var:newbie}}|| | ||
{{#vardefine:newbie|{{#if:{{{newbie|}}}|{{{newbie|}}}|{{#var:langbase}}/Newbie Notes{{#var:lang}}}}}} | |||
}} | |||
{{# | {{#if:{{#var:spec}}{{{spec|}}}| | ||
{{#vardefine:constants_nb|{{#var:constants_nb}}{{ | {{#vardefine:spec|{{#var:spec}}{{PBR}} | ||
{{{constants|}}}{{ | {{{spec|}}}{{PBR}}}} | ||
}} | |||
{{#if:{{#var:constants_nb}}{{{constants|}}}| | |||
{{#vardefine:constants_nb|{{#var:constants_nb}}{{PBR}} | |||
{{{constants|}}}{{PBR}}}} | |||
}} | |||
{{#vardefine:bugs|{{#var:bugs}} | {{#vardefine:bugs|{{#var:bugs}} | ||
{{{bugs|}}}}} | {{{bugs|}}}}} | ||
{{#vardefine:caveats|{{#ifexpr:{{{func_sleep|0.0}}}> 0.0|* <span id="caveats-sleep"></span> This function causes the script to sleep for {{{func_sleep|}}} seconds. {{{func_sleep_note|}}}|{{#if:{{{func_sleep_note|}}}|* <span id="caveats-sleep"></span> {{{func_sleep_note|}}}}}}}{{#if:{{#var:caveats}}| | {{#vardefine:caveats|{{#ifexpr:{{{func_sleep|0.0}}}> 0.0|* <span id="caveats-sleep"></span> This function causes the script to sleep for {{{func_sleep|}}} seconds. {{{func_sleep_note|}}}|{{#ifexpr:{{{func_sleep_frame|0}}}> 0|* <span id="caveats-sleep"></span> This function causes the script to sleep for {{{func_sleep_frame|}}} {{#ifexpr:{{{func_sleep_frame}}}> 1|frames|frame}}. {{{func_sleep_note|}}}|{{#if:{{{func_sleep_note|}}}|* <span id="caveats-sleep"></span> {{{func_sleep_note|}}}}}}}}}{{#if:{{#var:caveats}}| | ||
{{#var:caveats}}}}{{#if:{{{caveats|}}}| | {{#var:caveats}}}}{{#if:{{{caveats|}}}| | ||
{{{caveats|}}}}} | {{{caveats|}}}}}}} | ||
{{# | |||
{{#if:{{#pos:{{#var:moded}}|u}}||{{#vardefine:caveats|{{LSL_Generic/Caveats}}}}}} | |||
{{# | |||
{{#if:{{#var:examples}}{{{examples|}}}| | |||
{{#vardefine:examples|{{#var:examples}}{{ | {{#vardefine:examples|{{#var:examples}}{{PBR}} | ||
{{{examples|}}}{{ | {{{examples|}}}{{PBR}}}} | ||
}} | |||
{{#vardefine:simple-examples|{{#var:simple-examples}} | {{#vardefine:simple-examples|{{#var:simple-examples}} | ||
{{{ | {{{simple_examples|}}}}} | ||
{{#vardefine:complex-examples|{{#var:complex-examples}} | {{#vardefine:complex-examples|{{#var:complex-examples}} | ||
{{{ | {{{complex_examples|}}}}} | ||
{{#if:{{#var:helpers}}{{{helpers|}}}| | |||
{{#vardefine:helpers|{{#var:helpers}}{{ | {{#vardefine:helpers|{{#var:helpers}}{{PBR}} | ||
{{{helpers|}}}{{ | {{{helpers|}}}{{PBR}}}} | ||
}} | |||
{{#if:{{#var:also_header}}{{{also_header|}}}| | |||
{{#vardefine:also_header|{{#var:also_header}}{{ | {{#vardefine:also_header|{{#var:also_header}}{{PBR}} | ||
{{{also_header|}}}{{ | {{{also_header|}}}{{PBR}}}} | ||
}} | |||
{{#vardefine:also_constants|{{#var:also_constants}} | {{#vardefine:also_constants|{{#var:also_constants}} | ||
Line 106: | Line 130: | ||
{{{also_library|}}}}} | {{{also_library|}}}}} | ||
{{#if:{{#var:also_footer}}{{{also_footer|}}}| | |||
{{#vardefine:also_footer|{{#var:also_footer}}{{ | {{#vardefine:also_footer|{{#var:also_footer}}{{PBR}} | ||
{{{also_footer|}}}{{ | {{{also_footer|}}}{{PBR}}}} | ||
}} | |||
{{#if:{{#var:notes}}{{{notes|}}}| | |||
{{#vardefine:notes|{{#var:notes}}{{ | {{#vardefine:notes|{{#var:notes}}{{PBR}} | ||
{{{notes|}}}{{ | {{{notes|}}}{{PBR}}}} | ||
}} | |||
{{#if:{{#var:history}}{{{history|}}}| | |||
{{#vardefine:history|{{#var:history}}{{ | {{#vardefine:history|{{#var:history}}{{PBR}} | ||
{{{history|}}}{{ | {{{history|}}}{{PBR}}}} | ||
}} | |||
{{#if:{{#var:deepnotes}}{{{deepnotes|}}}| | |||
{{#vardefine:deepnotes|{{#var:deepnotes}}{{ | {{#vardefine:deepnotes|{{#var:deepnotes}}{{PBR}} | ||
{{{deepnotes|}}}{{ | {{{deepnotes|}}}{{PBR}}}} | ||
}} | |||
{{#if:{{#var:mono}}{{{mono|}}}| | |||
{{#vardefine:mono|{{#var:mono}}{{ | {{#vardefine:mono|{{#var:mono}}{{PBR}} | ||
{{{mono|}}}{{ | {{{mono|}}}{{PBR}}}} | ||
}} | |||
{{#if:{{#var:lso}}{{{lso|}}}| | |||
{{#vardefine:lso|{{#var:lso}}{{ | {{#vardefine:lso|{{#var:lso}}{{PBR}} | ||
{{{lso|}}}{{ | {{{lso|}}}{{PBR}}}} | ||
}} | |||
{{#vardefine:also_tests|{{#var:also_tests}} | {{#vardefine:also_tests|{{#var:also_tests}} | ||
{{{also_tests|}}}}} | {{{also_tests|}}}}} | ||
{{#if:{{#var:location}}{{{location|}}}| | |||
{{#vardefine:location|{{#var:location}}{{ | {{#vardefine:location|{{#var:location}}{{PBR}} | ||
{{{location|}}}{{ | {{{location|}}}{{PBR}}}} | ||
}} | |||
{{#if:{{#var:messaging}}{{{messaging|}}}| | |||
{{#vardefine:messaging|{{#var:messaging}}{{ | {{#vardefine:messaging|{{#var:messaging}}{{PBR}} | ||
{{{messaging|}}}{{ | {{{messaging|}}}{{PBR}}}} | ||
}} | |||
}}{{#if:{{#var:self}}|| __NOEDITSECTION__ | }}{{#if:{{#var:self}}|| __NOEDITSECTION__ | ||
}}{{#var:header}}{{#if:{{#var:func_id}}{{#var:mode}}|| | }}{{#var:header}}{{#if:{{#var:func_id}}{{#var:mode}}{{#var:moded}}|| | ||
{{#if:{{#var:self}}|| [[Category:LSL FixMe]] }} }}{{#if:{{#if:{{{return_type|}}}|{{#var:return_text}}}}{{{func_desc|}}}||<div id="box" style="background:yellow;"> | |||
'''Either 'func_desc' or 'return_type' & 'return_text' must be defined''' | '''Either 'func_desc' or 'return_type' & 'return_text' must be defined''' | ||
<div style="padding: 0.5em;background:#ffffff;"> | <div style="padding: 0.5em;background:#ffffff;"> | ||
''(Please use 'return_text' & 'return_type' or 'func_desc' to summarize the functions actions.)''</div></div>{{#if:{{#var:self}}|| [[Category:LSL FixMe]] }} }} | ''(Please use 'return_text' & 'return_type' or 'func_desc' to summarize the functions actions.)''</div></div>{{#if:{{#var:self}}|| [[Category:LSL FixMe]] }} }} | ||
{{RightToc|font-size:80%}} | {{RightToc|font-size:80%}} | ||
<div id="box"><h2 style="display:none"> Summary </h2>{{#ifexpr: | <div id="box"><h2 style="display:none"> Summary </h2>{{#ifexpr:{{#var:BugCounter|0}} > 0|<div class="mw-headline" style="float:right; margin: 5px 0.5em 0 0.5em;">{{LSL_Bug_Icon}}</div>}}<span id="{{anchorencode:Description}}" style="display:none"></span><span id="{{anchorencode:Summary}}" class="mw-headline" style="display:block; padding-bottom:0.17em; padding-top:0.5em; background:transparent none repeat scroll 0% 0%; color:#546368; font-family:Arial,Helvetica,Sans-Serif; background-color:#F4F8FB; border-bottom:1px dotted #AAAAAA; font-size:120%; font-weight:bold; margin:0pt; padding:0.2em 0.5em; text-align:left;"> [[:Category:LSL_Functions{{#var:lang}}|Function]]: {{#if:{{{return_type|}}}|[[{{{return_type|}}}{{#var:lang}}|{{{return_type|}}}]]||}} '''{{{func}}}'''( {{#if:{{{p1_name|}}}{{{p1_type|}}}| [[{{{p1_type|}}}{{#var:lang}}|{{{p1_type|}}}]] {{LSL Param|{{{p1_name|}}}}}{{#if:{{{p2_name|}}}{{{p2_type|}}}|, [[{{{p2_type|}}}{{#var:lang}}|{{{p2_type|}}}]] {{LSL Param|{{{p2_name|}}}}}{{#if:{{{p3_name|}}}{{{p3_type|}}}|, [[{{{p3_type|}}}{{#var:lang}}|{{{p3_type|}}}]] {{LSL Param|{{{p3_name|}}}}}{{#if:{{{p4_name|}}}{{{p4_type|}}}|, [[{{{p4_type|}}}{{#var:lang}}|{{{p4_type|}}}]] {{LSL Param|{{{p4_name|}}}}}{{#if:{{{p5_name|}}}{{{p5_type|}}}|, [[{{{p5_type|}}}{{#var:lang}}|{{{p5_type|}}}]] {{LSL Param|{{{p5_name|}}}}}{{#if:{{{p6_name|}}}{{{p6_type|}}}|, [[{{{p6_type|}}}{{#var:lang}}|{{{p6_type|}}}]] {{LSL Param|{{{p6_name|}}}}}{{#if:{{{p7_name|}}}{{{p7_type|}}}|, [[{{{p7_type|}}}{{#var:lang}}|{{{p7_type|}}}]] {{LSL Param|{{{p7_name|}}}}}{{#if:{{{p8_name|}}}{{{p8_type|}}}|, [[{{{p8_type|}}}{{#var:lang}}|{{{p8_type|}}}]] {{LSL Param|{{{p8_name|}}}}}{{#if:{{{p9_name|}}}{{{p9_type|}}}|, [[{{{p9_type|}}}{{#var:lang}}|{{{p9_type|}}}]] {{LSL Param|{{{p9_name|}}}}}{{#if:{{{p10_name|}}}{{{p10_type|}}}|, [[{{{p10_type|}}}{{#var:lang}}|{{{p10_type|}}}]] {{LSL Param|{{{p10_name|}}}}}{{#if:{{{p11_name|}}}{{{p11_type|}}}|, [[{{{p11_type|}}}{{#var:lang}}|{{{p11_type|}}}]] {{LSL Param|{{{p11_name|}}}}}{{#if:{{{p12_name|}}}{{{p12_type|}}}|, [[{{{p12_type|}}}{{#var:lang}}|{{{p12_type|}}}]] {{LSL Param|{{{p12_name|}}}}}}}}}}}}}}}}}}}}}}}}}}}}} )<nowiki>;</nowiki></span> | ||
<div style="padding: 0.5em; min-height: {{#if:{{{func_complexity|}}}|6em;|5em;}}">{{#if:{{#pos:{{#var:moded}}|u}}|{{#if:{{#var:floater}}|<div id="box" style="float:right;">{{#var:floater}}</div>}}|<div id="box" style="float:right; margin: 0 0.5em; font-size:90%;"> | |||
}}</div>}}<span id="{{anchorencode:Description}}" style="display:none"></span><span id="{{anchorencode:Summary}}" class="mw-headline" style="display:block; padding-bottom:0.17em; padding-top:0.5em; background:transparent none repeat scroll 0% 0%; color:#546368; font-family:Arial,Helvetica,Sans-Serif; background-color:#F4F8FB; border-bottom:1px dotted #AAAAAA; font-size:120%; font-weight:bold; margin:0pt; padding:0.2em 0.5em; text-align:left;"> [[:Category:LSL_Functions{{#var:lang}}|Function]]: {{#if:{{{return_type|}}}|[[{{{return_type|}}}{{#var:lang}}|{{{return_type|}}}]]||}} | |||
<div style="padding: 0.5em; min-height: {{#if:{{{func_complexity|}}}|6em;|5em;}}">{{# | |||
{{{!}} class="collapsible" | {{{!}} class="collapsible" | ||
{{!}}- style="font-size:75%;" | {{!}}- style="font-size:75%;" | ||
{{!}}+ | {{!}}+ | ||
{{!}}- | {{!}}- | ||
{{!}} {{HoverText|{{ | {{!}} {{HoverText|{{{func_sleep|}}}|The number of seconds this script will sleep after executing this function.}}{{HoverText|{{{func_sleep_frame|}}}|The number of frames this script will sleep after executing this function.}}{{#if:{{{func_sleep_note|}}}|{{HoverLink|#caveats-sleep|3=*|2={{{func_sleep_hover|{{{func_sleep_note|}}}}}}}}}} | ||
{{!}} [[LSL Delay{{#var:lang}}|Forced Delay]] | |||
{{!}} [[LSL Delay{{#var:lang}}|Delay]] | |||
{{!}}- | {{!}}- | ||
{{#if:{{{func_complexity|}}}| | {{#if:{{{func_complexity|}}}| | ||
Line 177: | Line 196: | ||
{{!}} [[Energy{{#var:lang}}|Energy]] | {{!}} [[Energy{{#var:lang}}|Energy]] | ||
{{!}}}</div>}} | {{!}}}</div>}} | ||
{{#if:{{#var:header_desc}}|{{#var:header_desc}}{{PBR}}{{#if:{{{return_type|}}}|<br id="bdart"/>}}}}{{#if:{{{return_type|}}}| Returns {{It|{{{return_type|}}}|{{{Return_text|}}}}} {{#if:{{#var:return_text}}| {{#var:return_text}} }}{{PBR}}}} | {{#if:{{#var:header_desc}}|{{#var:header_desc}}{{PBR}}{{#if:{{{return_type|}}}|<br id="bdart"/>}}}}{{#if:{{{return_type|}}}| Returns {{#if:{{{return_subtype|}}}|{{#if:{{{returns_text|}}}{{{Returns_text|}}}||{{ItBlind|{{#if:{{{return_subtype_disp|}}}|{{{return_subtype_disp|}}}|{{{return_subtype|}}}}}|{{{Return_text|}}}}}}} {{CAL|LSL {{ucfirst:{{{return_type|}}}}}/{{{return_subtype|}}}{{#var:lang}}|{{#if:{{{return_subtype_disp|}}}|{{{return_subtype_disp}}}|{{{return_subtype}}}}}}} ({{ItLink|{{{return_type|}}}}})|{{#if:{{{returns_text|}}}{{{Returns_text|}}}||{{It|{{{return_type|}}}|{{{Return_text|}}}}}}}}} {{#if:{{#var:return_text}}| {{#var:return_text}} }}{{PBR}}}} | ||
{{#if:{{{p1_name|}}}{{{p1_type|}}}|{{{!}} | {{#if:{{{p1_name|}}}{{{p1_type|}}}|{{{!}} | ||
{{LSL DefineRow|1={{{p1_type|}}}|2={{{p1_name|}}}|3={{#var:p_{{{p1_name|}}}_desc}}}} | {{LSL DefineRow|1={{{p1_type|}}}|2={{#if:{{{p1_subtype|}}}|{{CAL|LSL {{ucfirst:{{{p1_type|}}}}}/{{{p1_subtype|}}}{{#var:lang}}|{{{p1_name|}}}}}|{{LSL_Parameter_Link|{{{p1_name|}}}}}}}|3={{#var:p_{{{p1_name|}}}_desc}}}} | ||
{{#if:{{{p2_name|}}}{{{p2_type|}}}|{{LSL DefineRow|1={{{p2_type|}}}|2={{{p2_name|}}}|3={{#var:p_{{{p2_name|}}}_desc}}}} | {{#if:{{{p2_name|}}}{{{p2_type|}}}|{{LSL DefineRow|1={{{p2_type|}}}|2={{#if:{{{p2_subtype|}}}|{{CAL|LSL {{ucfirst:{{{p2_type|}}}}}/{{{p2_subtype|}}}{{#var:lang}}|{{{p2_name|}}}}}|{{LSL_Parameter_Link|{{{p2_name|}}}}}}}|3={{#var:p_{{{p2_name|}}}_desc}}}} | ||
{{#if:{{{p3_name|}}}{{{p3_type|}}}|{{LSL DefineRow|1={{{p3_type|}}}|2={{{p3_name|}}}|3={{#var:p_{{{p3_name|}}}_desc}}}} | {{#if:{{{p3_name|}}}{{{p3_type|}}}|{{LSL DefineRow|1={{{p3_type|}}}|2={{#if:{{{p3_subtype|}}}|{{CAL|LSL {{ucfirst:{{{p3_type|}}}}}/{{{p3_subtype|}}}{{#var:lang}}|{{{p3_name|}}}}}|{{LSL_Parameter_Link|{{{p3_name|}}}}}}}|3={{#var:p_{{{p3_name|}}}_desc}}}} | ||
{{#if:{{{p4_name|}}}{{{p4_type|}}}|{{LSL DefineRow|1={{{p4_type|}}}|2={{{p4_name|}}}|3={{#var:p_{{{p4_name|}}}_desc}}}} | {{#if:{{{p4_name|}}}{{{p4_type|}}}|{{LSL DefineRow|1={{{p4_type|}}}|2={{#if:{{{p4_subtype|}}}|{{CAL|LSL {{ucfirst:{{{p4_type|}}}}}/{{{p4_subtype|}}}{{#var:lang}}|{{{p4_name|}}}}}|{{LSL_Parameter_Link|{{{p4_name|}}}}}}}|3={{#var:p_{{{p4_name|}}}_desc}}}} | ||
{{#if:{{{p5_name|}}}{{{p5_type|}}}|{{LSL DefineRow|1={{{p5_type|}}}|2={{{p5_name|}}}|3={{#var:p_{{{p5_name|}}}_desc}}}} | {{#if:{{{p5_name|}}}{{{p5_type|}}}|{{LSL DefineRow|1={{{p5_type|}}}|2={{#if:{{{p5_subtype|}}}|{{CAL|LSL {{ucfirst:{{{p5_type|}}}}}/{{{p5_subtype|}}}{{#var:lang}}|{{{p5_name|}}}}}|{{LSL_Parameter_Link|{{{p5_name|}}}}}}}|3={{#var:p_{{{p5_name|}}}_desc}}}} | ||
{{#if:{{{p6_name|}}}{{{p6_type|}}}|{{LSL DefineRow|1={{{p6_type|}}}|2={{{p6_name|}}}|3={{#var:p_{{{p6_name|}}}_desc}}}} | {{#if:{{{p6_name|}}}{{{p6_type|}}}|{{LSL DefineRow|1={{{p6_type|}}}|2={{#if:{{{p6_subtype|}}}|{{CAL|LSL {{ucfirst:{{{p6_type|}}}}}/{{{p6_subtype|}}}{{#var:lang}}|{{{p6_name|}}}}}|{{LSL_Parameter_Link|{{{p6_name|}}}}}}}|3={{#var:p_{{{p6_name|}}}_desc}}}} | ||
{{#if:{{{p7_name|}}}{{{p7_type|}}}|{{LSL DefineRow|1={{{p7_type|}}}|2={{{p7_name|}}}|3={{#var:p_{{{p7_name|}}}_desc}}}} | {{#if:{{{p7_name|}}}{{{p7_type|}}}|{{LSL DefineRow|1={{{p7_type|}}}|2={{#if:{{{p7_subtype|}}}|{{CAL|LSL {{ucfirst:{{{p7_type|}}}}}/{{{p7_subtype|}}}{{#var:lang}}|{{{p7_name|}}}}}|{{LSL_Parameter_Link|{{{p7_name|}}}}}}}|3={{#var:p_{{{p7_name|}}}_desc}}}} | ||
{{#if:{{{p8_name|}}}{{{p8_type|}}}|{{LSL DefineRow|1={{{p8_type|}}}|2={{{p8_name|}}}|3={{#var:p_{{{p8_name|}}}_desc}}}} | {{#if:{{{p8_name|}}}{{{p8_type|}}}|{{LSL DefineRow|1={{{p8_type|}}}|2={{#if:{{{p8_subtype|}}}|{{CAL|LSL {{ucfirst:{{{p8_type|}}}}}/{{{p8_subtype|}}}{{#var:lang}}|{{{p8_name|}}}}}|{{LSL_Parameter_Link|{{{p8_name|}}}}}}}|3={{#var:p_{{{p8_name|}}}_desc}}}} | ||
{{#if:{{{p9_name|}}}{{{p9_type|}}}|{{LSL DefineRow|1={{{p9_type|}}}|2={{{p9_name|}}}|3={{#var:p_{{{p9_name|}}}_desc}}}} | {{#if:{{{p9_name|}}}{{{p9_type|}}}|{{LSL DefineRow|1={{{p9_type|}}}|2={{#if:{{{p9_subtype|}}}|{{CAL|LSL {{ucfirst:{{{p9_type|}}}}}/{{{p9_subtype|}}}{{#var:lang}}|{{{p9_name|}}}}}|{{LSL_Parameter_Link|{{{p9_name|}}}}}}}|3={{#var:p_{{{p9_name|}}}_desc}}}} | ||
{{#if:{{{p10_name|}}}{{{p10_type|}}}|{{LSL DefineRow|1={{{p10_type|}}}|2={{{p10_name|}}}|3={{#var:p_{{{p10_name|}}}_desc}}}} | {{#if:{{{p10_name|}}}{{{p10_type|}}}|{{LSL DefineRow|1={{{p10_type|}}}|2={{#if:{{{p10_subtype|}}}|{{CAL|LSL {{ucfirst:{{{p10_type|}}}}}/{{{p10_subtype|}}}{{#var:lang}}|{{{p10_name|}}}}}|{{LSL_Parameter_Link|{{{p10_name|}}}}}}}|3={{#var:p_{{{p10_name|}}}_desc}}}} | ||
{{#if:{{{p11_name|}}}{{{p11_type|}}}|{{LSL DefineRow|1={{{p11_type|}}}|2={{{p11_name|}}}|3={{#var:p_{{{p11_name|}}}_desc}}}} | {{#if:{{{p11_name|}}}{{{p11_type|}}}|{{LSL DefineRow|1={{{p11_type|}}}|2={{#if:{{{p11_subtype|}}}|{{CAL|LSL {{ucfirst:{{{p11_type|}}}}}/{{{p11_subtype|}}}{{#var:lang}}|{{{p11_name|}}}}}|{{LSL_Parameter_Link|{{{p11_name|}}}}}}}|3={{#var:p_{{{p11_name|}}}_desc}}}} | ||
{{#if:{{{p12_name|}}}{{{p12_type|}}}|{{LSL DefineRow|1={{{p12_type|}}}|2={{{p12_name|}}}|3={{#var:p_{{{p12_name|}}}_desc}}}} | {{#if:{{{p12_name|}}}{{{p12_type|}}}|{{LSL DefineRow|1={{{p12_type|}}}|2={{#if:{{{p12_subtype|}}}|{{CAL|LSL {{ucfirst:{{{p12_type|}}}}}/{{{p12_subtype|}}}{{#var:lang}}|{{{p12_name|}}}}}|{{LSL_Parameter_Link|{{{p12_name|}}}}}}}|3={{#var:p_{{{p12_name|}}}_desc}}}} | ||
}}}}}}}}}}}}}}}}}}}}}} | }}}}}}}}}}}}}}}}}}}}}} | ||
{{!}}} | {{!}}} | ||
Line 196: | Line 215: | ||
<div style="margin-top:0.5em;"></div> | <div style="margin-top:0.5em;"></div> | ||
{{#var:header_footnote}} | {{#var:header_footnote}} | ||
}}{{#if:{{#var:other_languages}}| | |||
<div style="margin-top:0.5em;"></div> | |||
{{#var:other_languages}} | |||
}}</div> | }}</div> | ||
</div>{{#ifexist:{{#var:newbie}}|<div id="box"> | </div>{{#ifexist:{{#var:newbie}}|<div id="box"> | ||
Line 270: | Line 292: | ||
{{#var:also_footer}} | {{#var:also_footer}} | ||
</div>}} | </div>}} | ||
</div></div>}} | </div></div>}}{{#if:{{#var:deepnotes}}{{#var:mono}}{{#var:lso}}{{#var:history}}{{#var:also_tests}}{{#var:location}}{{#var:messaging}}{{#var:footnotes}}{{#if:{{#pos:{{#var:moded}}|u}}||1}}{{{signature|}}}{{{haiku|}}}{{{poetry|}}}|<div id="box"> | ||
<div id="box"> | |||
== Deep Notes == | == Deep Notes == | ||
<div style="padding: 0.5em"><div> | <div style="padding: 0.5em"><div> | ||
Line 283: | Line 304: | ||
</div>}}{{#if:{{#var:history}}| | </div>}}{{#if:{{#var:history}}| | ||
<h4> History </h4><div> | <h4> History </h4><div> | ||
{{{!}} | |||
{{#var:history}} | {{#var:history}} | ||
{{!}}} | {{!}}} | ||
</div>}} | |||
{{#if:{{#var:also_tests}}| | |||
<h3>Tests</h3> | <h3>Tests</h3> | ||
{{{!}} | {{{!}} | ||
Line 306: | Line 323: | ||
{{{{#if:{{#var:footnotes}}|Footnotes|!}}|}} | {{{{#if:{{#var:footnotes}}|Footnotes|!}}|}} | ||
}} | }} | ||
</div></div>{{#if:{{{comments|}}}|<div id="box"> | {{Collapsible_Table|collapsed=*|table-style=width:100%;|title-style=text-align:left;|title=<h4 style="margin-top:0;">Signature</h4>|content={{!}} | ||
{{#tag:pre|{{#if:{{#pos:{{#var:moded}}|u}}||{{#if:{{#pos:{{#var:moded}}|r}}|//}}function {{#if:{{{return_type|}}}|{{{return_type|}}}|void}} {{{func}}}{{#if:{{{p1_name|}}}{{{p1_type|}}}|( {{{p1_type|}}} {{{p1_name|}}}{{#if:{{{p2_name|}}}{{{p2_type|}}}|, {{{p2_type|}}} {{{p2_name|}}}{{#if:{{{p3_name|}}}{{{p3_type|}}}|, {{{p3_type|}}} {{{p3_name|}}}{{#if:{{{p4_name|}}}{{{p4_type|}}}|, {{{p4_type|}}} {{{p4_name|}}}{{#if:{{{p5_name|}}}{{{p5_type|}}}|, {{{p5_type|}}} {{{p5_name|}}}{{#if:{{{p6_name|}}}{{{p6_type|}}}|, {{{p6_type|}}} {{{p6_name|}}}{{#if:{{{p7_name|}}}{{{p7_type|}}}|, {{{p7_type|}}} {{{p7_name|}}}{{#if:{{{p8_name|}}}{{{p8_type|}}}|, {{{p8_type|}}} {{{p8_name|}}}{{#if:{{{p9_name|}}}{{{p9_type|}}}|, {{{p9_type|}}} {{{p9_name|}}}{{#if:{{{p10_name|}}}{{{p10_type|}}}|, {{{p10_type|}}} {{{p10_name|}}}{{#if:{{{p11_name|}}}{{{p11_type|}}}|, {{{p11_type|}}} {{{p11_name|}}}{{#if:{{{p12_name|}}}{{{p12_type|}}}|, {{{p12_type|}}} {{{p12_name|}}}}}}}}}}}}}}}}}}}}}}}}} )|()}}<nowiki>;</nowiki>{{#if:{{{desc|}}}|//{{{desc|}}}}} | |||
<nowiki></nowiki>}}{{#if:{{{signature|}}}|{{{signature|}}} | |||
}}{{#if:{{#var:signature}}|{{#var:signature}} | |||
}}|id="lsl-signature"}}}} | |||
{{#if:{{{haiku|}}}{{{poetry|}}}|{{Collapsible_Table|collapsed=*|table-class=haiku|table-style=width:100%;|title-style=text-align:left;|title=<h4 style="margin-top:0;">Haiku</h4>|content={{!}} | |||
{{{haiku|}}} | |||
{{{poetry|}}} | |||
}}}} | |||
</div></div>}}{{#if:{{{comments|}}}|<div id="box"> | |||
<h2>Comments</h2> | <h2>Comments</h2> | ||
<div style="padding: 0.5em;"> | <div style="padding: 0.5em;"> | ||
Line 312: | Line 338: | ||
</div></div>}} | </div></div>}} | ||
<div style="display:none" class="hidden-text" id="hidden-text">{{#var:hidden-text}}</div> | <div style="display:none" class="hidden-text" id="hidden-text">{{#var:hidden-text}}</div> | ||
{{#var:footer}} {{#if:{{#var:self}}|| {{# | {{#var:footer}} {{#if:{{#var:self}}|| {{#if:{{#pos:{{#var:moded}}|r}}{{#pos:{{#var:moded}}|u}}|| {{#if:{{{haiku|}}}|[[Category:Articles with haiku{{#var:lang}}]]|[[Category:Articles in need of haiku{{#var:lang}}]]}}[[Category:LSL Functions{{#var:lang}}]] {{#if:{{{return_type|}}}|{{LSLC|Functions/Returns {{AAn|{{{return_type|}}}}}{{#var:lang}}}} {{#if:{{{return_subtype|}}}|{{LSLC|Functions/Returns a {{{return_type|}}}/{{{return_subtype|}}}{{#var:lang}}}}}}|{{LSLC|Functions/Returns nothing{{#var:lang}}}}}} {{#if:{{{p1_name|}}}{{{p1_type|}}}|{{LSLC|Parameters/{{{p1_name|}}}{{#var:lang}}}}{{#if:{{{p2_name|}}}{{{p2_type|}}}|{{LSLC|Parameters/{{{p2_name|}}}{{#var:lang}}}}{{#if:{{{p3_name|}}}{{{p3_type|}}}|{{LSLC|Parameters/{{{p3_name|}}}{{#var:lang}}}}{{#if:{{{p4_name|}}}{{{p4_type|}}}|{{LSLC|Parameters/{{{p4_name|}}}{{#var:lang}}}}{{#if:{{{p5_name|}}}{{{p5_type|}}}|{{LSLC|Parameters/{{{p5_name|}}}{{#var:lang}}}}{{#if:{{{p6_name|}}}{{{p6_type|}}}|{{LSLC|Parameters/{{{p6_name|}}}{{#var:lang}}}}{{#if:{{{p7_name|}}}{{{p7_type|}}}|{{LSLC|Parameters/{{{p7_name|}}}{{#var:lang}}}}{{#if:{{{p8_name|}}}{{{p8_type|}}}|{{LSLC|Parameters/{{{p8_name|}}}{{#var:lang}}}}{{#if:{{{p9_name|}}}{{{p9_type|}}}|{{LSLC|Parameters/{{{p9_name|}}}{{#var:lang}}}}{{#if:{{{p10_name|}}}{{{p10_type|}}}|{{LSLC|Parameters/{{{p10_name|}}}{{#var:lang}}}}{{#if:{{{p11_name|}}}{{{p11_type|}}}|{{LSLC|Parameters/{{{p11_name|}}}{{#var:lang}}}}{{#if:{{{p12_name|}}}{{{p12_type|}}}|{{LSLC|Parameters/{{{p12_name|}}}{{#var:lang}}}}}}}}}}}}}}}}}}}}}}}}}}}} {{#if:{{#pos:{{#var:moded}}|f}}|[[Category:LSL Keywords/Pre-release{{#var:lang}}]]|[[Category:LSL Keywords/All{{#var:lang}}]]{{#ifexpr:{{#var:BugCounter|0}} > 0|[[Category:LSL topics with bugs{{#var:lang}}]] [[Category:LSL topics with the most bugs{{#var:lang}}| {{padleft:{{#expr:100-{{#var:BugCounter|0}}}}|2|0}}{{PAGENAME}}]]}}}} {{#iferror:{{#expr:{{#var:func_id}}}}|[[Category:LSL Functions/Without IDs{{#var:lang}}]]|[[Category:LSL Functions/ID{{#var:lang}}| {{padleft:{{#var:func_id}}|5|0}}]]}} {{#if:{{#var:examples}}||[[Category:LSL Needs Example{{#var:lang}}]]}} {{LSL Unhelpful|{{{func}}}|}}}} {{#if:{{{cat1|}}}|[[Category:LSL {{{cat1}}}{{#var:lang}}]]}} {{#if:{{{cat2|}}}|[[Category:LSL {{{cat2}}}{{#var:lang}}]]}} {{#if:{{{cat3|}}}|[[Category:LSL {{{cat3}}}{{#var:lang}}]]}} {{#if:{{{cat4|}}}|[[Category:LSL {{{cat4}}}{{#var:lang}}]]}} {{#if:{{{cat5|}}}|[[Category:LSL {{{cat5}}}{{#var:lang}}]]}} {{#if:{{{cat6|}}}|[[Category:LSL {{{cat6}}}{{#var:lang}}]]}} {{#if:{{{cat7|}}}|[[Category:LSL {{{cat7}}}{{#var:lang}}]]}} {{#if:{{{cat8|}}}|[[Category:LSL {{{cat8}}}{{#var:lang}}]]}} }}</includeonly> |
Latest revision as of 08:08, 8 September 2024
LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
See Template:LSL Function/docs for documentation.