OSSL Standards
From OpenSimulator
m (Robot: Cosmetic changes) |
|||
| (6 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | {{ | + | {{Quicklinks}} |
<br /> | <br /> | ||
| Line 9: | Line 9: | ||
Base Syntax: osCategoryFunction() | Base Syntax: osCategoryFunction() | ||
| − | =Naming= | + | = Naming = |
| + | Function and parameter names should use US English spelling. <!-- Why? What's the rationale behind this? Please explain. --> | ||
| + | |||
Function should be clearly named & indicative of purpose, eg: | Function should be clearly named & indicative of purpose, eg: | ||
| − | osSendAnnounce - Mediocre | + | osSendAnnounce - Mediocre<br /> |
| − | osRegionAnnounce - Good | + | osRegionAnnounce - Good<br /> |
| − | osRegionAnnouncement - Better | + | osRegionAnnouncement - Better<br /> |
| − | ==Get/Set Functions== | + | == Get/Set Functions == |
Get/Set functions should be clearly named & use a common syntax for both Get and Set. In Get/Set examples, Get/Set are the first letters after 'os'. | Get/Set functions should be clearly named & use a common syntax for both Get and Set. In Get/Set examples, Get/Set are the first letters after 'os'. | ||
| Line 23: | Line 25: | ||
The Os() equivilent if they were to be created again should be something along the lines of | The Os() equivilent if they were to be created again should be something along the lines of | ||
| − | osGetTextureOffset() | + | osGetTextureOffset()<br /> |
| − | osSetTextureOffset() | + | osSetTextureOffset()<br /> |
This could be complemented with: | This could be complemented with: | ||
| − | osGetTextureURL() | + | osGetTextureURL()<br /> |
| − | osSetTextureURL() | + | osSetTextureURL()<br /> |
etc. | etc. | ||
| − | ==Category Examples== | + | == Category Examples == |
* Region - region admin and region-wide scoped functions. | * Region - region admin and region-wide scoped functions. | ||
| Line 49: | Line 51: | ||
etc. | etc. | ||
| + | |||
| + | = See Also = | ||
| + | * [[LSL Status|LSL/OSSL Status Page]] | ||
| + | * OSSL | ||
| + | ** [[OSSL Status/Types|OSSL Types Status Page]] | ||
| + | ** [[OSSL Status/Events|OSSL Events Status Page]] | ||
| + | ** [[OSSL Proposals|OSSL Proposed Functions]] | ||
| + | ** [[OSSL Implemented|OSSL Implemented Functions]] | ||
| + | ** [[OSSL Standards]] | ||
| + | |||
[[Category:Development]] | [[Category:Development]] | ||
| + | [[Category:OSSL]] | ||
Latest revision as of 19:41, 3 March 2012
 |
Languages: |
|
POLICY PROPOSAL: This document is a proposal for naming standards and is not yet active.
Base Syntax: osCategoryFunction()
[edit] Naming
Function and parameter names should use US English spelling.
Function should be clearly named & indicative of purpose, eg:
osSendAnnounce - Mediocre
osRegionAnnounce - Good
osRegionAnnouncement - Better
[edit] Get/Set Functions
Get/Set functions should be clearly named & use a common syntax for both Get and Set. In Get/Set examples, Get/Set are the first letters after 'os'.
Eg, llSetOffsetTexture and llTextureOffset are particularly good examples of how not to do it.
The Os() equivilent if they were to be created again should be something along the lines of
osGetTextureOffset()
osSetTextureOffset()
This could be complemented with:
osGetTextureURL()
osSetTextureURL()
etc.
[edit] Category Examples
- Region - region admin and region-wide scoped functions.
- osRegionAnnouncement()
- osRegionRestart()
- Permission - answers yes/no boolean questions as to whether the owner of the primitive, or the primitive has permission to do something.
- osGetPermissionEditLand()
- Texture - anything to do with textures on the primitive
- osGetTextureURL()
- osSetTextureText()
- Shape - anything to do with the primitives shape
- osSetShapePath()
- osSetShapePattern()
- osSetShapeColour()
etc.
