Template:Osslfunc
From OpenSimulator
(Difference between revisions)
m (Removed reference to category OSSL_functions_without_delay) |
m (Modified template to indicate if a function does not do a threat level check) |
||
Line 9: | Line 9: | ||
|colspan="2"|{{#if:{{{description|}}}|{{{description}}}|''No descriptions provided'' [[Category:OSSL_functions_without_descriptions]]}} | |colspan="2"|{{#if:{{{description|}}}|{{{description}}}|''No descriptions provided'' [[Category:OSSL_functions_without_descriptions]]}} | ||
|- valign="top" | |- valign="top" | ||
− | |width="100"|'''Threat Level'''||{{#if:{{{threat_level|}}}|{{{threat_level}}}|''No threat level specified'' [[Category:OSSL_functions_without_threat_level]]}} | + | |width="100"|'''Threat Level'''||{{#if:{{{threat_level|}}}|{{#switch:{{{threat_level|}}} |
+ | | off = This function does not do a threat level check | ||
+ | | None | ||
+ | | Nuisance | ||
+ | | VeryLow | ||
+ | | Low | ||
+ | | Moderate | ||
+ | | High | ||
+ | | VeryHigh | ||
+ | | Severe | ||
+ | | #default = {{{threat_level}}} }}|''No threat level specified'' [[Category:OSSL_functions_without_threat_level]] }} | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
|'''Permissions'''||{{#if:{{{permissions|}}}|{{#switch:{{{permissions|}}} | |'''Permissions'''||{{#if:{{{permissions|}}}|{{#switch:{{{permissions|}}} |
Revision as of 12:59, 13 December 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.