Access
All Enumerations (Enums) are defined globally as tables. You can access their members directly using the Enum name, followed by either the dot (.) operator or the bracket ([]) operator and the desired value name.
Enum Usage Example
Members
This section lists all globally defined Enumeration tables (Enums). These tables provide readable names for numerical constants, allowing you to access a constant value by using the Enum’s global name followed by its member name (e.g.,EventType.Draw).
EventType
This enumeration lists the available event triggers that scripts can register functions to handle using theevent.set function.
number
Triggered on each frame draw.
number
Triggered on tick fired
(10ms).number
Triggered on heartbeat fired
(1000ms).number
Triggered when a new entry is registered.
number
Triggered when a registered entry has left the game.
number
Triggered when all scripts or the software is unloaded.
NotificationType
This enumartion lists the available notification types that can be used to register a notification widget using themenu.add_notification function.
number
No identifier.
number
Green identifier.
number
Red identifier.
number
Orange identifier.
number
Blue identifier.
number
Accent color identifier.
GlobalType
This enumeration lists the available global section types that you can use with themenu.set_global and menu.get_global functions.
number
Ignored miscellaneous section used for storing Alpha / Shift.
number
The assist section used for storing the Assist page globals.
number
The enemy players section used for storing the Players->Enemies page globals.
number
The friend players section used for storing the Players->Friendlies page globals.
number
The client players section used for storing the Players->Client page globals.
number
The players section used for storing the Players page globals.
number
The visuals section used for storing the Visuals page globals.
number
The misc section used for storing the Misc page globals.
number
The style section used for storing the Style window globals.
number
The settings section used for storing the Config window globals.
ModelFlags
This enumeration defines various binary flags used to represent the current state or properties of a ModelObject for checking in Lua scripts. These flags can be checked against a ModelObject’s Flags property using the bitwise AND operator (&).
number
Flag indicating that the model is currently not transparent (Visible).
number
Flag indicating that the model is in a ‘God Mode’ or invulnerable state.
number
Flag indicating that the model is currently in a ragdoll or collapsed physics state.
number
Flag indicating that the model is protected by a forcefield.
number
Flag indicating that the model has not yet taken any damage.
number
Flag indicating that the model is currently dead.
number
Flag indicating that the model is currently holding a tool.
number
Flag indicating that the model is outside of the Workspace service (Primitive Nulled out).
EntryExclude
This enumeration defines flags used to specify which types of entries should be excluded or filtered when retrieving the entry list.number
Does not exclude any entries; returns all entries regardless of their current state (e.g., even if they are in a removing state).
number
Excludes entries that are currently in a removing or invalid state, returning only actively loaded entries.
number
Excludes entries that do not have an associated ModelObject, returning only entries with a ModelObject.