Difference between revisions of "Template:LSLFunctionAll"

From Second Life Wiki
Jump to navigation Jump to search
Line 1: Line 1:
__NOTOC__ <includeonly> {{#ifeq:{{FULLPAGENAME}}|Template:LSLFunctionAll|| __NOEDITSECTION__ }} {{#if:{{{depreciated|}}}{{{deprecated|}}}|
__NOTOC__ <noinclude>
== Main ==
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.
 
It uses the template [[Template:LSLFunction]] to render the first box.
 
One problem with using this template, is you must turn off section editing for the page (the template does that for you)
 
If most fields are left blank they do not show up.
Set 'depreciated=none' if the function is depreciated but lacks a replacement.
 
<pre>
{{LSLFunctionAll
|func=llFunction
|func_id
|func_sleep=0.0
|func_energy=0.0
|func_desc
|func_footnote
|depreciated
|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
|return_type=integer
|return_text=that is set to zero.
|constants
|spec=Function template thingy
|caveats
|examples
|related
|helpers
|also
|notes
}}
</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)
|depreciated=depreciated (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
|related=related(hides if excluded)
|helpers=helpers(hides if excluded)
|also=also(hides if excluded)
|notes=notes
}}
</div>
</noinclude>
<includeonly> {{#ifeq:{{FULLPAGENAME}}|Template:LSLFunctionAll|| __NOEDITSECTION__ }} {{#if:{{{depreciated|}}}{{{deprecated|}}}|
<div id="box" style="background:red;">
<div id="box" style="background:red;">
&nbsp;&nbsp;'''Deprecated Function'''
&nbsp;&nbsp;'''Deprecated Function'''
<div style="padding: 0.5em;background:#ffffff;">
<div style="padding: 0.5em;background:#ffffff;">
''(This function has been depreciated{{#ifeq:{{{depreciated|}}}{{{deprecated|}}}|none|.|, please use {{LSLG|{{{depreciated|}}}{{{deprecated|}}}}} instead.}}''</div></div>[[Category:LSL Depreciated]]}} <!-- {{lowercase|{{{func}}}}} -->
''(This function has been deprecated{{#ifeq:{{{depreciated|}}}{{{deprecated|}}}|none|.|, please use {{LSLG|{{{depreciated|}}}{{{deprecated|}}}}} instead.}}''</div></div>[[Category:LSL Deprecated]]}} <!-- {{lowercase|{{{func}}}}} -->
{| width="100%"
{| width="100%"
|-
|-
Line 93: Line 173:
|}
|}
{{ #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: {{{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><noinclude>
</includeonly>
 
== Main ==
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.
 
It uses the template [[Template:LSLFunction]] to render the first box.
 
One problem with using this template, is you must turn off section editing for the page (the template does that for you)
 
If most fields are left blank they do not show up.
Set 'depreciated=none' if the function is depreciated but lacks a replacement.
 
<pre>
{{LSLFunctionAll
|func=llFunction
|func_id
|func_sleep=0.0
|func_energy=0.0
|func_desc
|func_footnote
|depreciated
|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
|return_type=integer
|return_text=that is set to zero.
|constants
|spec=Function template thingy
|caveats
|examples
|related
|helpers
|also
|notes
}}
</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)
|depreciated=depreciated (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
|related=related(hides if excluded)
|helpers=helpers(hides if excluded)
|also=also(hides if excluded)
|notes=notes
}}
</div>
</noinclude>

Revision as of 17:44, 27 January 2007

Main

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.

It uses the template Template:LSLFunction to render the first box.

One problem with using this template, is you must turn off section editing for the page (the template does that for you)

If most fields are left blank they do not show up. Set 'depreciated=none' if the function is depreciated but lacks a replacement.

{{LSLFunctionAll
|func=llFunction
|func_id
|func_sleep=0.0
|func_energy=0.0
|func_desc
|func_footnote
|depreciated
|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
|return_type=integer
|return_text=that is set to zero.
|constants
|spec=Function template thingy
|caveats
|examples
|related
|helpers
|also
|notes
}}

Example

  Deprecated Function

(This function has been deprecated, please use depreciated (if you set to none, it excludes this text) instead.

return_type func( float only, float sets , float type, float and, float name, float pairs, float that, float are, float needed );

func_id Function ID
func_sleep Delay
func_energy Energy

func_desc(hides if excluded)

Returns a return_type return_text(hides if excluded, if return_type is excluded this value is ignored)

• float only – excluded if not set
• float sets
• float type – excluded if not set
• float and
• float name – excluded if not set
• float pairs
• float that – excluded if not set
• float are
• float needed – excluded if not set


func_footnote(hides if excluded)

Specification

spec(hides if excluded)

Constants

constants(hides if excluded)

Caveats

caveats(defaults to none)

Examples

examples

Helper Functions

helpers(hides if excluded)

Notes

notes

See Also

  • Functions
related(hides if excluded)
also(hides if excluded)
This page is based on information gathered from the Second Life client source, and as such has additional licensing restrictions.