The following Naming Convention applies to all Global Variables in order of Appearance:
XPS_
- the primary prefix used by both Main and Core
- Main and Core should be considered the same addon despite being two seperate PBO files. This is to provide a ‘Lite’ version of XPS which only includes Main.
XPS_Addon (with no underscore or further text after)
- A True/False variable indicating the preInit has finished for that Addon’s PBO file.
XPS_Addon_
- Indicates Addon (similar to “Namespace” in Java/C#) in terms of HashmapObjects or Files
- Usually shortened (See Addon Guide to the Right)
XPS_Addon_filetype_FileName
- Filetype is typically three (sometimes four) lowercase letters to indicate the purpose of the SQF file. (See SQF File Type Guide to the right)
- FileName can be any length. Filename is retained as part of the Global name for ease of lookup
XPS_Addon_VariableName (without filetype)
- A Global Instance of a type
- May be a Static Instance (compileFinal’d)
- VariableName might be a compound name if referring to a sub class
- e.g. XPS_Addon_Pets_Dog : refers to a Dog item/class, which is a sub-item/class of Pets class.
These are similar to Dot-Notation but with underscores.
Addon Guide
Friendly Name |
Long Name |
Short Name |
Main |
Main |
|
Core Library |
Core |
|
Action Planning |
Action_Planning |
AP |
Behaviour Trees |
Behaviour_Trees |
BT |
Map Grids |
Map_Grids |
MG |
Pathfinding |
Pathfinding |
PF |
Unit Testing |
Unit_Testing |
UT |
SQF File Types