Magic Variables: Difference between revisions
Jump to navigation
Jump to search
m (_this) |
(Vistual appearance of the page and some formatting) |
||
| Line 2: | Line 2: | ||
== Introduction == | == Introduction == | ||
'''Magic variables''' are engine maintained [[Variables|variables]] that serve a specific purpose within a given scope and are often used by the engine to push data to a given [[Script (File)|script]] or [[Code|code]] fragment. They are usually no longer present after leaving the scope (e.g. after code execution or after a [[forEach]] statement). | '''Magic variables''' are engine maintained [[Variables|variables]] that serve a specific purpose within a given scope and are often used by the engine to push data to a given [[Script (File)|script]] or [[Code|code]] fragment.<br>They are usually no longer present after leaving the scope (e.g. after code execution or after a [[forEach]] statement). | ||
{{Cfg ref|start}} | |||
{{Cfg ref|abc}} | |||
== Generic == | |||
==== _this ==== | ==== _this ==== | ||
Is used to make arguments of a script call ([[call]], [[exec]], [[execVM]], [[spawn]]) visible and accessible to the script. | Is used to make arguments of a script call ([[call]], [[exec]], [[execVM]], [[spawn]]) visible and accessible to the script. | ||
| Line 25: | Line 22: | ||
==== _forEachIndex ==== | ==== _forEachIndex ==== | ||
Represents the (zero-based) index of a [[forEach]] | Represents the (zero-based) index of a [[forEach]] '''x'''. | ||
| Line 37: | Line 34: | ||
==== _thisFSM ==== | ==== _thisFSM ==== | ||
</div> | </div> | ||
The FSM id for FSMs executed with [[execFSM]]. | The [[FSM]] id for FSMs executed with [[execFSM]]. | ||
| Line 58: | Line 55: | ||
==== thisList ==== | ==== thisList ==== | ||
[[Variable]] defined by [[Triggers]] and [[Waypoints]]: | [[Variables|Variable]] defined by [[Triggers]] and [[Waypoints]]: | ||
* Triggers: | * Triggers: | ||
** accessible within the '''Condition''', '''On Activation''' or '''On Deactivation''' script | ** accessible within the '''Condition''', '''On Activation''' or '''On Deactivation''' script | ||
** defines an array of objects that are currently fulfilling the trigger's condition (same as what is returned by the [[list]] command) | ** defines an array of objects that are currently fulfilling the trigger's condition (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. | ** '''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: | * Waypoints: | ||
** accessible within the '''Condition''' or ''On Activation''' script | ** accessible within the '''Condition''' or ''On Activation''' script | ||
| Line 72: | Line 69: | ||
== Specifics == | |||
<div><div style="float: left; margin-right: 0.5em;">{{GVI|ofpr|1.85}}</div> | <div><div style="float: left; margin-right: 0.5em;">{{GVI|ofpr|1.85}}</div> | ||
==== onMapSingleClick: _pos,_alt,_shift,_units ==== | ==== onMapSingleClick: _pos,_alt,_shift,_units ==== | ||
</div> | </div> | ||
See [[onMapSingleClick]] | *See [[onMapSingleClick]] | ||
| Line 84: | Line 80: | ||
==== onPlayerConnected: _id,_uid,_name,_jip,_owner ==== | ==== onPlayerConnected: _id,_uid,_name,_jip,_owner ==== | ||
</div> | </div> | ||
See [[onPlayerConnected]] | *See [[onPlayerConnected]] | ||
[[Category: Scripting Topics]] | [[Category: Scripting Topics]] | ||
Revision as of 16:40, 3 May 2018
Introduction
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
Generic
_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.
_thisEventHandler
The script handle (not the EH index!) for Event Handlers added with addEventHandler or addMPEventHandler.
_thisFSM
The FSM id for FSMs executed with execFSM.
_thisScript
The called or spawned script handle from within itself.
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 are currently fulfilling the trigger's condition (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.
Specifics
onMapSingleClick: _pos,_alt,_shift,_units
- See onMapSingleClick