Magic Variables: Difference between revisions
Lou Montana (talk | contribs) m (Add category) |
m (category) |
||
Line 74: | Line 74: | ||
{{Cfg ref|end}} | {{Cfg ref|end}} | ||
[[Category: Scripting Topics]] | [[Category: Scripting Topics]] | ||
Revision as of 11:58, 24 December 2020
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).
Template:Cfg ref
Template:Cfg ref
_this
Is used to make arguments of a script call (call, exec, execVM, spawn) visible and accessible to the script.
_x
Represents the current element during a loop with: apply, count, configClasses, configProperties, findIf, forEach, select.
Exception handling using a try-catch statement declares this variable which contains details about the thrown exception in the try block.
_forEachIndex
Represents the (zero-based) index of a forEach _x element.
4
The index for Event Handlers added with addEventHandler, addMPEventHandler or addMissionEventHandler.
4
The FSM id for FSMs executed with execFSM.
4
The called or spawned script handle from within itself.
_time
SQS ONLY. The time elapsed since the script started running.
4
Template:note From within a Function, the TAG_fnc_functionName function name as string (e.g. "myTag_fnc_myFunction")
4
Template:note From within a Function, name of the function that called the current one (_fnc_scriptName used when not defined)
this
- In Addons' config files (e.g. UserActions, onInit, etc.): The object the entry belongs to
- In Dialogs: The player unit that activated control (e.g. via mouseEnter). false if non-activated
- In Object's "Init" line: The object the init line belongs to
- 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)
thisList
Variable defined by Triggers and Waypoints:
- Triggers:
- 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.
- Waypoints:
- accessible within the Condition or On Activation script
- defines an array containing all group members that completed the respective waypoint
thisTrigger
Refers to the trigger object itself - accessible within the Condition, On Activation or On Deactivation script.