Template:Osslfunc
From OpenSimulator
(Difference between revisions)
m (Changed "Function delay" to "Delay".) |
m (Added a switch for the permissions to add some canned messages for true and false settings) |
||
Line 34: | Line 34: | ||
| VeryHigh = [[Category:OSSL Functions/ThreatLevel:VeryHigh]] | | VeryHigh = [[Category:OSSL Functions/ThreatLevel:VeryHigh]] | ||
| Severe = [[Category:OSSL Functions/ThreatLevel:Severe]] | | Severe = [[Category:OSSL Functions/ThreatLevel:Severe]] | ||
+ | }} | ||
+ | {{#switch:{{permissions|}} | ||
+ | | true = Use of this function is always allowed by default | ||
+ | | false = Use of this function is always disabled by default | ||
+ | | #default = {{permissions}} | ||
}} | }} | ||
</includeonly> | </includeonly> |
Revision as of 08:28, 12 August 2016
This template is to be used as follows (copy and paste the following into a new page):
{{osslfunc |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 | Yes |
permissions | who may use this OSSL function | Yes |
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.
For deprecated functions, use Template:Osslfunc/Deprecated instead of this template.