Magic variables are engine-maintained variables that serve a specific purpose within a given scope and are often used by the engine to push data to a given script or code fragment.
They are usually no longer present after leaving the scope (e.g. after code execution or after a forEach statement).
Is used to make arguments of a script call (call, exec, execVM, spawn) visible and accessible to the script, also used in Event Handlers to pass appropriate params.
Represents the current element during a loop with: apply, count, configClasses, configProperties, findIf, forEach, select.
Iterating over a HashMap with forEach will return the key as _x and the value as _y.
Exception handling using a try-catch statement declares this variable which contains details about the thrown exception in the try block.
Represents the (zero-based) index of a forEach/forEachReversed _x element.
Additional Event Handler arguments available with addMissionEventHandler
The index for Event Handlers added with addEventHandler, addMPEventHandler, addMissionEventHandler or addUserActionEventHandler.
The index for Scripted Event Handlers added with BIS_fnc_addScriptedEventHandler.
The name of the Event added with addEventHandler, addMPEventHandler, addMissionEventHandler or addUserActionEventHandler, as well as for config types EHs.
The FSM id for FSMs executed with execFSM.
The execVMed, called or spawned script handle from within itself.
SQS ONLY. The time elapsed since the script started running.
From within a Function, the TAG_fnc_functionName function name as string (e.g. "myTag_fnc_myFunction")
From within a Function, name of the function that called the current one (_fnc_scriptName used when not defined)
- In Addons' config files (e.g. UserActions, onInit, etc.): The object to which the entry belongs
- In Dialogs: The player unit that activated control (e.g. via mouseEnter). false if non-activated
- In Object's "Init" line: The object to which the init line belongs
- In Triggers
- In Waypoints
- "Condition" or "On Activation/Deactivation" line: The group leader that completed the respective waypoint (or driver, if waypoint is assigned to a vehicle)
Variable defined by Triggers and Waypoints:
- accessible within the Condition, On Activation or On Deactivation script
- defines an array of objects that have been detected by the trigger (same as what is returned by the list command)
- thisList in a trigger's On Deactivation field seems to be undefined, and should not be used. It will either return an empty array, or possibly the contents of a different trigger.
- accessible within the Condition or On Activation script
- defines an array containing all group members that completed the respective waypoint
Refers to the trigger object itself - accessible within the Condition, On Activation or On Deactivation script.