Template:Osslfunc
From OpenSimulator
(Difference between revisions)
m (Use ignored for no threat level check. Updated descriptions for threat_level and permissions properties) |
m (Added display of units for delay value) |
||
| Line 26: | Line 26: | ||
| #default = {{{permissions}}} }}|''No permissions specified'' [[Category:OSSL_functions_without_permissions]]}} | | #default = {{{permissions}}} }}|''No permissions specified'' [[Category:OSSL_functions_without_permissions]]}} | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
| − | |'''Delay'''||{{#if:{{{delay|}}}|{{{delay}}}|''No function delay specified''}} | + | |'''Delay'''||{{#if:{{{delay|}}}|{{{delay}}} seconds|''No function delay specified''}} |
{{#if:{{{ossl_example|}}}| | {{#if:{{{ossl_example|}}}| | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
Revision as of 11:23, 25 October 2017
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.
