Template:Osslfunc

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Updated to include function permissions and delay information)
 
(15 intermediate revisions by one user not shown)
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|}}}
|'''Permissions'''||{{#if:{{{permissions|}}}|{{{permissions}}}|''No permissions specified'' [[Category:OSSL_functions_without_permissions]]}}
+
| ignored = This function does not do a threat level check
|'''Function delay'''||{{#if:{{{delay|}}}|{{{delay}}}|''No function delay specified'' [[Category:OSSL_functions_without_delay]]}}
+
| None
 +
| Nuisance
 +
| VeryLow
 +
| Low
 +
| Moderate
 +
| High
 +
| VeryHigh
 +
| Severe = {{{threat_level}}}
 +
| #default = {{{threat_level}}} is unknown threat level }}|''No threat level specified'' [[Category:OSSL_functions_without_threat_level]] }}
 +
{{!}}- valign="top"
 +
|'''Permissions'''||{{#if:{{{permissions|}}}|{{#switch:{{{permissions|}}}
 +
| true  = Use of this function is always allowed by default
 +
| false = Use of this function is always disabled by default
 +
| #default = {{{permissions}}} }}|''No permissions specified'' [[Category:OSSL_functions_without_permissions]]}}
 +
{{!}}- valign="top"
 +
|'''Extra Delay'''||{{#if:{{{delay|}}}|{{{delay}}} seconds|''No function delay specified''}}
 
{{#if:{{{ossl_example|}}}|
 
{{#if:{{{ossl_example|}}}|
 
{{!}}- valign="top"
 
{{!}}- valign="top"
Line 33: Line 48:
 
| Severe = [[Category:OSSL Functions/ThreatLevel:Severe]]
 
| Severe = [[Category:OSSL Functions/ThreatLevel:Severe]]
 
}}
 
}}
{{permissions}}
 
 
</includeonly>
 
</includeonly>
 
<noinclude>
 
<noinclude>
Line 61: Line 75:
 
|description||definitions or descriptions||Yes
 
|description||definitions or descriptions||Yes
 
|-
 
|-
|threat_level||[[Threat level]]||Yes
+
|threat_level||[[Threat level]]&nbsp;&nbsp;&nbsp;(Use ignored for functions that do not check threat level)||No
 
|-
 
|-
|permissions||who may use this OSSL function||Yes
+
|permissions||who may use this OSSL function&nbsp;&nbsp;&nbsp;(Use true for a function that is available to everyone) ||No
 
|-
 
|-
|delay||Any penalty (delay in seconds) for using this function||No
+
|delay||any penalty (delay in seconds) for using this function||No
 
|-
 
|-
 
|ossl_example||sample codes||No
 
|ossl_example||sample codes||No

Latest revision as of 09:37, 28 April 2021


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   (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.

For deprecated functions, use Template:Osslfunc/Deprecated instead of this template.

Personal tools
General
About This Wiki