Skip to content

Naming Conventions

x87 edited this page Apr 26, 2021 · 11 revisions
  • self is the parameter (normally the first one, but in exceptional cases can be out of order), usually a variable, that is the handle of the class entity (e.g. a char, car or player handle)

  • state is a boolean argument in a command that enables or disables something, the alternative term is flag

  • handle is the last parameter in the constructor commands that stores the result

  • If the command has a parameter that is a handle of another class (Car/Char/Blip/Pickup, etc) and there are no other handle parameters, we call this parameter handle: <className>

    • If the command has multiple parameters that are handles we call them after the class name:

    XXXX.GrabEntityOnRopeForObject(self:Object, car: Car, char: Char, object: Object) // 0798

Clone this wiki locally