R3vo/Sandbox1 – User
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).
| Variable | Description | Data Types | Used In | Introduced With |
|---|---|---|---|---|
| thisTrigger |
Refers to the trigger object itself - accessible within the Condition, On Activation or On Deactivation script. |
N/A | ||
|
thisList |
"Variable defined by Triggers and Waypoints:
|
N/A | ||
|
this |
|
See description. |
N/A | |
|
_y |
Iterating over a HashMap with forEach will return the key as _x and the value as _y. |
See description. |
||
|
_x |
Represents the current element during a loop with: apply, count, configClasses, configProperties, findIf, forEach, select. |
apply, count, configClasses, configProperties, findIf, forEach, select |
N/A | |
|
_units |
Stores units depending on the context it is used in. |
|||
|
_topic |
Stores the topic name. | String | ||
|
_to |
Stores the unit that was switched to in onTeamSwitch. | Object | onTeamSwitch | |
|
_time |
SQS ONLY. The time elapsed since the script started running. |
In SQS scripts. |
N/A | |
|
_thisScript |
The execVMed, called or spawned script handle from within itself. |
See description. |
N/A | |
|
_thisFSM |
Number | execFSM | ||
| _thisEventHandler | The index for Event Handlers added with addEventHandler, addMPEventHandler or addMissionEventHandler. | Number | addEventHandler, addMissionEventHandler, addMPEventHandler | N/A |
| _thisEvent | The name of the Event added with addEventHandler, addMPEventHandler or addMissionEventHandler as well as for config types EHs. | String | addEventHandler, addMissionEventHandler, addMPEventHandler | |
| _thisArgs | Additional event handler arguments available with addMissionEventHandler. | Array | addMissionEventHandler | |
| _this | 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. | String | addAction, addEventHandler, addMissionEventHandler, addMPEventHandler, addMusicEventHandler, addPublicVariableEventHandler, call, ctrlAddEventHandler, ctrlSetEventHandler, displayAddEventHandler, displaySetEventHandler, editorSetEventHandler, exec, execFSM, execVM, inGameUISetEventHandler, kbAddTopic, onGroupIconClick, setMusicEventHandler, spawn, try | N/A |
| _target | Object | addAction, commandFSM, doFSM | N/A | |
| _shift | Returns whether or not ⇧ Shift was pressed. | Boolean | onDoubleClick, onMapSingleClick | |
| _sentenceId | Contains the ID of given sentence. | String ??? | kbAddTopic | |
| _pos | Contains a position. What position depends on the command it was used in. | Array | onDoubleClick, onMapSingleClick, onShowNewObject | N/A |
| _owner | Owner id of the leaving player. | Number | onPlayerDisconnected, onPlayerConnected | |
| _new | Contains the newly created object. Old 3D-Editor only. | Object | addEditorObject | |
| _name | Profile name of the the player. | String | onPlayerDisconnected, onPlayerConnected | |
| _leader | Contains the group leader. | Object | doFSM | |
| _jip | Returns whether or not the player joined in progress. | Boolean | onPlayerDisconnected, onPlayerConnected | |
| _isSelected | ? | ? |
? | |
|
_isHighCommand |
Returns true if player is in high command. |
? | ||
|
_id |
? |
? |
? | |
|
_group |
Contains the newly selected group. |
? | ||
|
_from |
? |
? |
? | |
|
_forEachIndex |
? | |||
|
_fnc_scriptNameParent |
From within a Function, name of the function that called the current one (_fnc_scriptName used when not defined) |
- |
? | |
|
_fnc_scriptName |
From within a Function, the TAG_fnc_functionName function name as string (e.g. "myTag_fnc_myFunction") |
- |
? | |
|
_exception |
Exception handling using a try-catch statement declares this variable which contains details about the thrown exception in the try block. |
? |
? | |
|
_destination |
? |
? |
? | |
| _alt | Returns whether or not Alt was pressed | Boolean | onDoubleClick, onMapSingleClick | N/A |
|
_uid |
User ID of leaving player. |
? |