Template:Lslfunc/doc
From OpenSimulator
(Difference between revisions)
CodyCooper (Talk | contribs) (Created page with "This template is to be used as follows (copy and paste the following into a new page): <pre> {{osslfunc |function_syntax= |csharp_syntax= |description= |threat_level= |permis...") |
CodyCooper (Talk | contribs) |
||
| Line 1: | Line 1: | ||
This template is to be used as follows (copy and paste the following into a new page): | This template is to be used as follows (copy and paste the following into a new page): | ||
| + | {{lslfunc | ||
| + | |function_syntax= | ||
| + | |csharp_syntax= | ||
| + | |description= | ||
| + | |threat_level= | ||
| + | |permissions= | ||
| + | |delay= | ||
| + | |ossl_example= | ||
| + | |additional_info= | ||
| + | }} | ||
<pre> | <pre> | ||
| − | {{ | + | {{lslfunc |
|function_syntax= | |function_syntax= | ||
|csharp_syntax= | |csharp_syntax= | ||
Revision as of 11:15, 12 March 2019
This template is to be used as follows (copy and paste the following into a new page):
Either 'func_desc' or 'return_type' & 'return_text' must be defined
(Please use 'return_text' & 'return_type' or 'func_desc' to summarize the functions actions.)
Contents |
Examples
{{lslfunc
|function_syntax=
|csharp_syntax=
|description=
|threat_level=
|permissions=
|delay=
|ossl_example=
|additional_info=
}}
| Property | Description | Required |
| function_syntax | syntax in LSL | Yes |
| csharp_syntax | syntax in C# | No |
| description | definitions or descriptions | Yes |
| threat_level | Threat level (Use ignored for functions that do not check threat level) | No |
| permissions | who may use this OSSL function (Use true for a function that is available to everyone) | No |
| delay | any penalty (delay in seconds) for using this function | No |
| ossl_example | sample codes | No |
| additional_info | notes, hints or so | No |
You can find some infomation about OSSL functions within IOSSL_Api.cs or OSSL_Api.cs. If you unsure what to fill in, feel free to leave it empty and wait for experts shown up:)
If you have added some additional common facilities like threat level, feel free to add it to this template.
Features of this template:
- Includes the {{quicklinks}} template
- Automatically adds the article to all the relevant categories
- Displays a placeholder text when required information is missing, and adds the article to the relevant "missing" category/categories.
