Template:lSL Function/docs

{{LSL_Function
|func
|func_id
|func_sleep
|func_energy
|func_desc
|func_footnote
|return_type
|return_text
|p1_type|p1_name|p1_desc|p1_hover
|p2_type|p2_name|p2_desc|p2_hover
|p3_type|p3_name|p3_desc|p3_hover
|p4_type|p4_name|p4_desc|p4_hover
|p5_type|p5_name|p5_desc|p5_hover
|p6_type|p6_name|p6_desc|p6_hover
|p7_type|p7_name|p7_desc|p7_hover
|p8_type|p8_name|p8_desc|p8_hover
|p9_type|p9_name|p9_desc|p9_hover
|p10_type|p10_name|p10_desc|p10_hover
|p11_type|p11_name|p11_desc|p11_hover
|p12_type|p12_name|p12_desc|p12_hover
|constants
|spec
|caveats
|examples
|helpers
|also_header
|also_functions
|also_tests
|also_events
|also_articles
|also_footer
|notes
|mode
|deprecated
|location
|cat1
|cat2
|cat3
|cat4
|cat5
|cat6
}}

The LSL_Function template is a intermediate template for LSL_Generic, which handles the formating for both functions and events (LSL_Event is also an intermediate template). The main job of this template is to change the parameter, names & setup the right-side floater. Also makes permission requirements a part of the template.

parameter	desc	example
func	Function name
func_id	Function ID	1.0
func_sleep	Delay	0.0
func_energy	Energy	10.0
func_desc	Function description text.	Gives the monkey a banana
func_footnote	Function footnote (appears after the parameters text).	Has the side effect of causing the avatar to run in circles shouting like on fire.
return_type	return type	integer
return_text	"Returns a return_type return_text" in most cases return_text can be used instead of func_desc.	that is a monkey
p1_type	first parameter type
p1_name	first parameter name
p1_desc	first parameter desc
p1_hover	first parameter hover, if not included it defaults to p1_desc
p2_type	second parameter type
p2_name	second parameter name
p2_desc	second parameter desc
p2_hover	second parameter hover, if not included it defaults to p2_desc
...
p12_type	twelfth parameter type
p12_name	twelfth parameter name
p12_desc	twelfth parameter desc
p12_hover	twelfth parameter hover, if not included it defaults to p12_desc
constants	constants area, no box, please use a table for this section.
spec	spec box
caveats	caveats box
examples	examples box
helpers	helper functions box
also_header	also header
also_functions	also functions indent
also_events	also events indent
also_articles	also articles indent
also_tests	also tests indent
also_footer	also footer
notes	notes box
mode	If mode equals 'god' then it is tagged as requiring godmode. If set to 'request' marks the page as a feature request. If set to 'user' avoids function being added to LSL Function Index, thus enabling usage of this template for documentation of User Functions.
deprecated	Marks the function as deprecated. Set the value to the replacement functions name or 'none'. If it is not set to none and it is infact set, it will include a link to the replacement function.
self	Special field that you only set if you don't want the function to be included in any categories.
cat1	An LSL specific category and sets the proper sort. (example would add the function to the "LSL Stub" category)	Stub
cat2	"
cat3	"
cat4	"
cat5	"
cat6	"
sort	not required but used to specify the sort order, if excluded the wiki will calculate this value for you.
location	optional: location box, used to say which source file it is defined in.
history	a box for function history

Template:Needs Translation/LSL/de Template:Needs Translation/LSL/es Template:Needs Translation/LSL/el Template:Needs Translation/LSL/fr Template:Needs Translation/LSL/he Template:Needs Translation/LSL/it Template:Needs Translation/LSL/ko Template:Needs Translation/LSL/nl Template:Needs Translation/LSL/hu Template:Needs Translation/LSL/no Template:Needs Translation/LSL/da Template:Needs Translation/LSL/sv Template:Needs Translation/LSL/tr Template:Needs Translation/LSL/pl Template:Needs Translation/LSL/pt Template:Needs Translation/LSL/th Template:Needs Translation/LSL/uk Template:Needs Translation/LSL/zh-Hans Template:Needs Translation/LSL/zh-Hant

/LSL

Function/docs

Summary

Function: void MyFunction( integer i, float f, string s, key k, list l, vector v, rotation r );

100.5	Forced Delay
0.0	Energy

A fictitious function^[1]
Returns a void (aka nadda, nothing).

• integer	i
• float	f
• string	s
• key	k
• list	l
• vector	v
• rotation	r

func_footnote

Newbie Notes

onlyinclude - Newbie Notes Summary
blah
blah
blah
blah
blah
blah
blah
blah
blah
blah
blah

To continue reading: Template:LSL Function/docs/Newbie Notes

To continue reading see: Newbie Notes

Specification

spec

constants

Caveats

• This function causes the script to sleep for 100.5 seconds.caveats

Examples

examples

Useful Snippets

helpers

Notes

notes

See Also

also_header

Events

• also_events

Functions

• also_functions

Articles

• also_articles

also_footer

Deep Notes

History

history

Tests

• also_tests

Source

location

Footnotes

1. ^ Footnote test

Signature
function void MyFunction( integer i, float f, string s, key k, list l, vector v, rotation r );