Difference between revisions of "Template:LSLFunctionAll"

From Second Life Wiki
Jump to navigation Jump to search
Line 148: Line 148:
{{#if:{{{depreciated|}}}{{{deprecated|}}}|* This function has been deprecated{{#ifeq:{{{depreciated|}}}{{{deprecated|}}}|none||, please use {{LSLG|{{{depreciated|}}}{{{deprecated|}}}}} instead}}.|}}
{{#if:{{{depreciated|}}}{{{deprecated|}}}|* This function has been deprecated{{#ifeq:{{{depreciated|}}}{{{deprecated|}}}|none||, please use {{LSLG|{{{depreciated|}}}{{{deprecated|}}}}} instead}}.|}}
{{#ifeq:{{{mode|}}}|god|* This function can only be executed in God Mode.|}}
{{#ifeq:{{{mode|}}}|god|* This function can only be executed in God Mode.|}}
{{#if: {{{depreciated|}}}{{{deprecated|}}}{{{caveats|}}} | {{{caveats|}}} | * None known.}}
{{#if: {{{depreciated|}}}{{{deprecated|}}}{{{caveats|}}}{{#ifeq:{{{mode|}}}|god|god|}} | {{{caveats|}}} | * None known.}}
</div>
</div>
</div>
</div>

Revision as of 21:05, 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 'deprecated=none' if the function is depreciated but lacks a replacement.

If a function requires godmode set 'mode=god'. Any other value has no effect.

{{LSLFunctionAll
|func=llFunction
|func_id
|func_sleep=0.0
|func_energy=0.0
|func_desc
|func_footnote
|deprecated
|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
|helpers
|also_header
|also_functions
|also_articles
|also_footer
|notes
|mode
}}

Example

  Deprecated Function

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

  Requires God Mode

(This function can only be executed in God Mode.)

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

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