OSSL Standards
From OpenSimulator
m (Added note about preferred spelling. Minor formatting changes.) |
(→Naming) |
||
| Line 10: | Line 10: | ||
=Naming= | =Naming= | ||
| − | Function and parameter names should use US English spelling. | + | 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: | ||
Revision as of 15:07, 10 December 2010
 |
Languages: |
|
POLICY PROPOSAL: This document is a proposal for naming standards and is not yet active.
Base Syntax: osCategoryFunction()
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
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.
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.
