|
|
| Line 1: |
Line 1: |
| {{LSL Header}} __NOTOC__ <noinclude>
| | <includeonly>{{LSL Function |
| == Main ==
| | |{{{func}}}| |
| This template renders ever function page. If it is to be edited it should be done in such a way as to not break existing content.
| | |func_id={{{func_id}}} |
| | | |func_sleep={{{func_sleep}}} |
| It uses the template [[Template:LSLFunction]] to render the first box.
| | |func_energy={{{func_energy}}} |
| | | |func_desc={{{func_desc|}}} |
| One problem with using this template, is you must turn off section editing for the page (the template does that for you)
| | |func_footnote={{{func_footnote|}}} |
| | | |deprecated={{{deprecated|}}}{{{depreciated|}}} |
| If most fields are left blank they do not show up.
| | |return_type={{{return_type|}}} |
| Set 'deprecated=none' if the function is depreciated but lacks a replacement.
| | |return_text={{{return_text|}}} |
| | | |p1_type={{{p1_type|}}}|p1_name={{{p1_name|}}}|p1_desc={{{p1_desc|}}} |
| If a function requires godmode set 'mode=god'. Any other value has no effect.
| | |p2_type={{{p2_type|}}}|p2_name={{{p2_name|}}}|p2_desc={{{p2_desc|}}} |
| | | |p3_type={{{p3_type|}}}|p3_name={{{p3_name|}}}|p3_desc={{{p3_desc|}}} |
| <pre>
| | |p4_type={{{p4_type|}}}|p4_name={{{p4_name|}}}|p4_desc={{{p4_desc|}}} |
| {{LSLFunctionAll | | |p5_type={{{p5_type|}}}|p5_name={{{p5_name|}}}|p5_desc={{{p5_desc|}}} |
| |func=llFunction
| | |p6_type={{{p6_type|}}}|p6_name={{{p6_name|}}}|p6_desc={{{p6_desc|}}} |
| |func_id
| | |p7_type={{{p7_type|}}}|p7_name={{{p7_name|}}}|p7_desc={{{p7_desc|}}} |
| |func_sleep=0.0
| | |p8_type={{{p8_type|}}}|p8_name={{{p8_name|}}}|p8_desc={{{p8_desc|}}} |
| |func_energy=0.0
| | |p9_type={{{p9_type|}}}|p9_name={{{p9_name|}}}|p9_desc={{{p9_desc|}}} |
| |func_desc
| | |p10_type={{{p10_type|}}}|p10_name={{{p10_name|}}}|p10_desc={{{p10_desc|}}} |
| |func_footnote
| | |p11_type={{{p11_type|}}}|p11_name={{{p11_name|}}}|p11_desc={{{p11_desc|}}} |
| |deprecated
| | |p12_type={{{p12_type|}}}|p12_name={{{p12_name|}}}|p12_desc={{{p12_desc|}}} |
| |p1_type|p1_name|p1_desc
| | |constants={{{constants|}}} |
| |p2_type|p2_name|p2_desc
| | |spec={{{spec|}}} |
| |p3_type|p3_name|p3_desc
| | |caveats={{{caveats|}}} |
| |p4_type|p4_name|p4_desc
| | |examples={{{examples|}}} |
| |p5_type|p5_name|p5_desc
| | |helpers={{{helpers|}}} |
| |p6_type|p6_name|p6_desc
| | |also_header={{{also_header|}}} |
| |p7_type|p7_name|p7_desc
| | |also_events={{{also_events|}}} |
| |p8_type|p8_name|p8_desc
| | |also_functions={{{also_functions|}}} |
| |p9_type|p9_name|p9_desc
| | |also_articles={{{also_articles|}}} |
| |p10_type|p10_name|p10_desc
| | |also_footer={{{also_footer|}}} |
| |p11_type|p11_name|p11_desc
| | |notes={{{notes|}}} |
| |p12_type|p12_name|p12_desc
| | |mode={{{mode|}}} |
| |return_type=integer
| | }}</includeonly><noinclude>#REDIRECT [[Template:LSL Function]]</noinclude> |
| |return_text=that is set to zero.
| |
| |constants
| |
| |spec=Function template thingy
| |
| |caveats | |
| |examples
| |
| |helpers
| |
| |also_header
| |
| |also_functions
| |
| |also_articles
| |
| |also_footer
| |
| |notes
| |
| |mode
| |
| }}
| |
| </pre>
| |
| | |
| ==Example==
| |
| <div id="box">
| |
| {{LSLFunctionAll | |
| |func=func
| |
| |func_id=func_id
| |
| |func_sleep=func_sleep
| |
| |func_energy=func_energy
| |
| |func_desc=func_desc(hides if excluded)
| |
| |func_footnote=func_footnote(hides if excluded)
| |
| |deprecated=deprecated (if you set to none, it excludes this text)
| |
| |p1_type=float|p1_name=only|p1_desc=excluded if not set
| |
| |p2_type=float|p2_name=sets|p2_desc
| |
| |p3_type=float|p3_name=type|p3_desc=excluded if not set
| |
| |p4_type=float|p4_name=and|p4_desc
| |
| |p5_type=float|p5_name=name|p5_desc=excluded if not set
| |
| |p6_type=float|p6_name=pairs|p6_desc
| |
| |p7_type=float|p7_name=that|p7_desc=excluded if not set
| |
| |p8_type=float|p8_name=are|p8_desc
| |
| |p9_type=float|p9_name=needed|p9_desc=excluded if not set
| |
| |p10_type|p10_name|p10_desc
| |
| |p11_type|p11_name|p11_desc
| |
| |p12_type|p12_name|p12_desc
| |
| |return_type=return_type
| |
| |return_text=return_text(hides if excluded, if return_type is excluded this value is ignored)
| |
| |constants=constants(hides if excluded)
| |
| |spec=spec(hides if excluded)
| |
| |caveats=caveats(defaults to none)
| |
| |examples=examples
| |
| |helpers=helpers(hides if excluded)
| |
| |also_header=also_header(hides if excluded)
| |
| |also_functions=also_functions(hides if excluded)
| |
| |also_articles=also_articles(hides if excluded)
| |
| |also_footer=also_footer(hides if excluded)
| |
| |notes=notes
| |
| |mode=god
| |
| }} | |
| </div></noinclude><includeonly> {{#ifeq:{{FULLPAGENAME}}|Template:LSLFunctionAll|| __NOEDITSECTION__ }} {{#if:{{{depreciated|}}}{{{deprecated|}}}|
| |
| <div id="box" style="background:red;">
| |
| '''Deprecated Function'''
| |
| <div style="padding: 0.5em;background:#ffffff;">
| |
| ''(This function has been deprecated{{#ifeq:{{{depreciated|}}}{{{deprecated|}}}|none|.|, please use {{LSLG|{{{depreciated|}}}{{{deprecated|}}}}} instead.)}}''</div></div>{{#ifeq:{{FULLPAGENAME}}|Template:LSLFunctionAll|| [[Category:LSL Deprecated]] }} |}}{{#ifeq:{{{mode|}}}|god|
| |
| <div id="box" style="background:yellow;">
| |
| '''Requires God Mode'''
| |
| <div style="padding: 0.5em;background:#ffffff;">
| |
| ''(This function can only be executed in God Mode.)''</div></div>{{#ifeq:{{FULLPAGENAME}}|Template:LSLFunctionAll|| [[Category:LSL_God_Mode]] }} |}}{{#if:{{{return_text|}}}{{{func_desc|}}}||
| |
| <div id="box" style="background:yellow;">
| |
| ''' 'return_text' and 'func_desc' can both not be undefined'''
| |
| <div style="padding: 0.5em;background:#ffffff;">
| |
| ''(Please use 'return_text' or 'func_desc' to describe the functions actions.)''</div></div>{{#ifeq:{{FULLPAGENAME}}|Template:LSLFunctionAll|| [[Category:LSL FixMe]] }} }} <!-- {{lowercase|{{{func}}}}} -->
| |
| {| width="100%"
| |
| |-
| |
| |valign="top"|
| |
| {{LSLFunction|{{{func}}}|{{{func_id|}}}|{{{func_sleep|}}}|{{{func_energy|}}}| | |
| |r={{{return_type|}}} | |
| |rd={{{return_text|}}} | |
| |p1t={{{p1_type|}}}|p1={{{p1_name|}}}|p1d={{{p1_desc|}}} | |
| |p2t={{{p2_type|}}}|p2={{{p2_name|}}}|p2d={{{p2_desc|}}} | |
| |p3t={{{p3_type|}}}|p3={{{p3_name|}}}|p3d={{{p3_desc|}}} | |
| |p4t={{{p4_type|}}}|p4={{{p4_name|}}}|p4d={{{p4_desc|}}} | |
| |p5t={{{p5_type|}}}|p5={{{p5_name|}}}|p5d={{{p5_desc|}}} | |
| |p6t={{{p6_type|}}}|p6={{{p6_name|}}}|p6d={{{p6_desc|}}} | |
| |p7t={{{p7_type|}}}|p7={{{p7_name|}}}|p7d={{{p7_desc|}}} | |
| |p8t={{{p8_type|}}}|p8={{{p8_name|}}}|p8d={{{p8_desc|}}} | |
| |p9t={{{p9_type|}}}|p9={{{p9_name|}}}|p9d={{{p9_desc|}}} | |
| |p10t={{{p10_type|}}}|p10={{{p10_name|}}}|p10d={{{p10_desc|}}} | |
| |p11t={{{p11_type|}}}|p11={{{p11_name|}}}|p11d={{{p11_desc|}}} | |
| |p12t={{{p12_type|}}}|p12={{{p12_name|}}}|p12d={{{p12_desc|}}} | |
| |tb={{{func_desc|}}} | |
| |te={{{func_footnote|}}}
| |
| }} | |
| |- | |
| |{{ #if: {{{spec|}}} |
| |
| <div id="box">
| |
| == Specification ==
| |
| <div style="padding: 0.5em">
| |
| {{{spec}}} | |
| </div>
| |
| </div>
| |
| | }}
| |
| |-
| |
| |{{ #if: {{{constants|}}} |
| |
| <div id="box">
| |
| == Constants ==
| |
| <div style="padding: 0.5em">
| |
| {{{constants}}}
| |
| </div>
| |
| </div>
| |
| | }} | |
| |-
| |
| |<div id="box">
| |
| == Caveats ==
| |
| <div style="padding: 0.5em">
| |
| {{#if:{{{depreciated|}}}{{{deprecated|}}}|* This function has been deprecated{{#ifeq:{{{depreciated|}}}{{{deprecated|}}}|none||, please use {{LSLG|{{{depreciated|}}}{{{deprecated|}}}}} instead}}.<br />|}}{{#ifeq:{{{mode|}}}|god|* This function can only be executed in God Mode.<br />|}}{{#if: {{{depreciated|}}}{{{deprecated|}}}{{{caveats|}}}{{#ifeq:{{{mode|}}}|god|god|}} | {{{caveats|}}} | * None known.}}
| |
| </div>
| |
| </div>
| |
| |-
| |
| |{{ #if: {{#if:{{{depreciated|}}}{{{deprecated|}}}||t}}{{{examples|}}} |
| |
| <div id="box">
| |
| == Examples ==
| |
| <div style="padding: 0.5em">
| |
| {{ #if: {{{examples|}}} | {{{examples|}}} | }}
| |
| </div>
| |
| </div>
| |
| |}}
| |
| |- | |
| |{{ #if: {{{helpers|}}} |
| |
| <div id="box">
| |
| == Helper Functions ==
| |
| <div style="padding: 0.5em">
| |
| {{{helpers}}} | |
| </div>
| |
| </div>
| |
| | }}
| |
| |-
| |
| |{{ #if: {{#if:{{{depreciated|}}}{{{deprecated|}}}||t}}{{{notes|}}} | | |
| <div id="box">
| |
| == Notes ==
| |
| <div style="padding: 0.5em">
| |
| {{ #if: {{{notes|}}} | {{{notes|}}} | }}
| |
| </div>
| |
| </div>
| |
| |}}
| |
| |- | |
| |{{ #if: {{{also_footer|}}}{{{related|}}}{{{also_functions|}}}{{{also_articles|}}}{{{also_header|}}} |
| |
| <div id="box">
| |
| == See Also ==
| |
| <div style="padding: 0.5em">
| |
| {{ #if: {{{also_header|}}} | {{{also_header}}}<br /> |}}{{ #if: {{{related|}}}{{{also_functions|}}} |
| |
| <ul><li> Functions </li></ul>
| |
| <dl><dd>
| |
| {{{related|}}}
| |
| {{{also_functions|}}}</dl> | }}{{ #if: {{{also_articles|}}} |
| |
| <ul><li> Articles </li></ul>
| |
| <dl><dd>
| |
| {{{also_articles}}}</dl> | }} {{{also_footer|}}}
| |
| </div> | |
| </div>
| |
| | }}
| |
| |}
| |
| {{ #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> }}</includeonly>
| |