Code guidelines

From Suf

If you're not familar with scripting, read on..

[edit] Variable Types

Within the examples of the definitions on this wiki, you may see some strange words in brackets. These are types of variables.

• Number variables
  • FLOAT (this is a number, it can be a whole number or a decimal.)
  • INTEGER (this is a whole number.)

• Switches
  • BOOL / BOOLEAN (this is a switch, it can be either TRUE or FALSE, sometimes indicated by a 0 (false) or a 1 (true).)

• 3D
  • 3DMESHFILE (this is a 3d mesh file, such as 'example.mesh'. it must be replicated with the '.mesh' extention.)
  • VECTOR / VECTOR3D (this is a position in 3d space, it's defined as 3 floats with a space between them, in the format of X position, Y position and Z position. the format of a vector is "Left/right position Up/down position Fore/aft position" for example '3 5 7' would be 3 units right 5 units up and 7 units foreward)

• Letters/Logic
  • ENUM
  • STRING (Letters, A to Z, including ascii charicters, often encased inside quotation marks.)