Difference between revisions of "Template:LSLFunctionAll"
Line 10: | Line 10: | ||
|r={{{return_type|}}} | |r={{{return_type|}}} | ||
|rd={{{return_text|}}} | |rd={{{return_text|}}} | ||
|p1t={{{p1_type|}}}|p1={{{p1_name|}}}|p1d={{{p1_desc|}}} | |p1t={{{p1_type|}}}|p1={{{p1_name|}}}|p1d={{{p1_desc|}}} | ||
|p2t={{{p2_type|}}}|p2={{{p2_name|}}}|p2d={{{p2_desc|}}} | |p2t={{{p2_type|}}}|p2={{{p2_name|}}}|p2d={{{p2_desc|}}} | ||
Line 102: | Line 101: | ||
One problem with using this template, is you must turn off section editing for the page (the template does that for you) | 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> | <pre> | ||
Line 111: | Line 113: | ||
|func_desc | |func_desc | ||
|func_footnote | |func_footnote | ||
|depreciated | |||
|p1_type|p1_name|p1_desc | |p1_type|p1_name|p1_desc | ||
|p2_type|p2_name|p2_desc | |p2_type|p2_name|p2_desc | ||
Line 136: | Line 139: | ||
</pre> | </pre> | ||
</noinclude> | </noinclude> | ||
==Example== | |||
{{LSLFunctionAll | |||
|func=func | |||
|func_id=func_id | |||
|func_sleep=func_sleep | |||
|func_energy=func_energy | |||
|func_desc=func_desc | |||
|func_footnote=func_footnote | |||
|depreciated=depreciated (if you set to none, it excludes this 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 | |||
|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 | |||
}} |
Revision as of 17:06, 26 January 2007
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
return_type func( );
func_desc
| ||||||
Specificationspec(hides if excluded) | ||||||
Constantsconstants(hides if excluded) | ||||||
Caveatscaveats(defaults to none) | ||||||
Examplesexamples | ||||||
Helper Functionshelpers(hides if excluded) | ||||||
Notesnotes | ||||||
Related Functionsrelated(hides if excluded) | ||||||
See Alsoalso(hides if excluded) |
Example
Template loop detected: Template:LSLFunctionAll