Magic Variables - Revision history

Lou Montana: Some wiki formatting

2025-04-12T22:25:21Z

Some wiki formatting

← Older revision		Revision as of 00:25, 13 April 2025
Line 4:		Line 4:
	They are usually no longer present after leaving the scope (e.g. after code execution or after a [[forEach]]-statement).		They are usually no longer present after leaving the scope (e.g. after code execution or after a [[forEach]]-statement).

			=== _this ===

	~~==== _this ====~~
	Used to make the arguments of a script call ([[call]], [[exec]], [[execVM]], [[spawn]]) visible and accessible to the script. Also used by [[:Category:Event Handlers\|Event Handlers]] to provide parameters.		Used to make the arguments of a script call ([[call]], [[exec]], [[execVM]], [[spawn]]) visible and accessible to the script. Also used by [[:Category:Event Handlers\|Event Handlers]] to provide parameters.

			=== _x ===

	~~==== _x ====~~
	Represents the current element during iteration with [[apply]], [[count]], [[configClasses]], [[configProperties]], [[findIf]], [[forEach]] and [[select]].		Represents the current element during iteration with [[apply]], [[count]], [[configClasses]], [[configProperties]], [[findIf]], [[forEach]] and [[select]].

			{{ArgTitle\|3\|_y\|{{GVI\|arma3\|2.02}}}}

	~~{{ArgTitle\|4\|_y\|{{GVI\|arma3\|2.02}}}}~~
	Iterating over a [[HashMap]] with [[forEach]] will return the key as [[#x\|_x]] and the value as [[#y\|_y]].		Iterating over a [[HashMap]] with [[forEach]] will return the key as [[#x\|_x]] and the value as [[#y\|_y]].

			{{ArgTitle\|3\|_exception\|{{GVI\|arma1\|1.00}}}}

	~~{{ArgTitle\|4\|_exception\|{{GVI\|arma1\|1.00}}}}~~
	[[Exception handling]] using a [[try]]-[[catch]]-statement declares this variable which contains details about the [[throw\|thrown]] exception in the [[try]]-block.		[[Exception handling]] using a [[try]]-[[catch]]-statement declares this variable which contains details about the [[throw\|thrown]] exception in the [[try]]-block.

			{{ArgTitle\|3\|_fnc_scriptName\|{{GVI\|arma3\|1.00}}}}

	~~{{ArgTitle\|4\|_fnc_scriptName\|{{GVI\|arma3\|1.00}}}}~~
	{{Feature\|informative\|Not engine-maintained, but added by {{hl\|functions_f/initFunctions.sqf}} – see [[scriptName]].}}		{{Feature\|informative\|Not engine-maintained, but added by {{hl\|functions_f/initFunctions.sqf}} – see [[scriptName]].}}
	Within a [[:Category:Functions\|Function]], the {{hl\|TAG_fnc_functionName}} function name (e.g. {{hl\|"myTag_fnc_myFunction"}}).		Within a [[:Category:Functions\|Function]], the {{hl\|TAG_fnc_functionName}} function name (e.g. {{hl\|"myTag_fnc_myFunction"}}).

			{{ArgTitle\|3\|_fnc_scriptNameParent\|{{GVI\|arma3\|1.00}}}}

	~~{{ArgTitle\|4\|_fnc_scriptNameParent\|{{GVI\|arma3\|1.00}}}}~~
	{{Feature\|informative\|Not engine-maintained, but added by {{hl\|functions_f/initFunctions.sqf}} – see [[scriptName]].}}		{{Feature\|informative\|Not engine-maintained, but added by {{hl\|functions_f/initFunctions.sqf}} – see [[scriptName]].}}
	Within a [[:Category:Functions\|Function]], the name of the function that called the current function (same as [[#fnc_scriptName\|_fnc_scriptName]] if the function was not called by another function).		Within a [[:Category:Functions\|Function]], the name of the function that called the current function (same as [[#fnc_scriptName\|_fnc_scriptName]] if the function was not called by another function).

			{{ArgTitle\|3\|_forEachIndex\|{{GVI\|arma2oa\|1.55}}}}

	~~{{ArgTitle\|4\|_forEachIndex\|{{GVI\|arma2oa\|1.55}}}}~~
	Represents the (zero-based) index of a [[forEach]]- / [[forEachReversed]]-loop.		Represents the (zero-based) index of a [[forEach]]- / [[forEachReversed]]-loop.

			{{ArgTitle\|3\|_self\|{{GVI\|arma3\|2.14}}}}

	~~{{ArgTitle\|4\|_self\|{{GVI\|arma3\|2.14}}}}~~
	Available in HashMapObject methods. Contains the HashMapObject instance that the method was invoked on (see [[createHashMapObject]]).		Available in HashMapObject methods. Contains the HashMapObject instance that the method was invoked on (see [[createHashMapObject]]).

			{{ArgTitle\|3\|_thisArgs\|{{GVI\|arma3\|2.04}}}}

	~~{{ArgTitle\|4\|_thisArgs\|{{GVI\|arma3\|2.04}}}}~~
	Additional Event Handler arguments available with [[addMissionEventHandler]].		Additional Event Handler arguments available with [[addMissionEventHandler]].

			{{ArgTitle\|3\|_thisEvent\|{{GVI\|arma3\|2.06}}}}

	~~{{ArgTitle\|4\|_thisEvent\|{{GVI\|arma3\|2.06}}}}~~
	The name of the Event added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]],[[addUserActionEventHandler]], [[ctrlAddEventHandler]] and [[displayAddEventHandler]], as well as for config types EHs.		The name of the Event added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]],[[addUserActionEventHandler]], [[ctrlAddEventHandler]] and [[displayAddEventHandler]], as well as for config types EHs.

			{{ArgTitle\|3\|_thisEventHandler\|{{GVI\|arma3\|1.64}}}}

	~~{{ArgTitle\|4\|_thisEventHandler\|{{GVI\|arma3\|1.64}}}}~~
	The index for Event Handlers added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]], [[addUserActionEventHandler]], [[ctrlAddEventHandler]] and [[displayAddEventHandler]].		The index for Event Handlers added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]], [[addUserActionEventHandler]], [[ctrlAddEventHandler]] and [[displayAddEventHandler]].

			{{ArgTitle\|3\|_thisFSM\|{{GVI\|arma3\|1.54}}}}

	~~{{ArgTitle\|4\|_thisFSM\|{{GVI\|arma3\|1.54}}}}~~
	The [[FSM]] ID for FSMs executed with [[execFSM]].		The [[FSM]] ID for FSMs executed with [[execFSM]].

			{{ArgTitle\|3\|_thisScript\|{{GVI\|arma3\|1.54}}}}

	~~{{ArgTitle\|4\|_thisScript\|{{GVI\|arma3\|1.54}}}}~~
	The [[Script Handle]] of a script started with [[execVM]], [[call]] or [[spawn]].		The [[Script Handle]] of a script started with [[execVM]], [[call]] or [[spawn]].

			{{ArgTitle\|3\|_thisScriptedEventHandler\|{{GVI\|arma3\|1.68}}}}

	~~{{ArgTitle\|4\|_thisScriptedEventHandler\|{{GVI\|arma3\|1.68}}}}~~
	The index for Scripted Event Handlers added with [[BIS_fnc_addScriptedEventHandler]].		The index for Scripted Event Handlers added with [[BIS_fnc_addScriptedEventHandler]].

			=== _time ===

	~~==== _time ====~~
	{{Feature\|warning\|[[SQS Syntax\|SQS]] only.}}		{{Feature\|warning\|[[SQS Syntax\|SQS]] only.}}
	The time elapsed since the script started running.		The time elapsed since the script started running.

			=== this ===

	~~==== this ====~~
	* '''Addon Config Files''' (e.g. UserActions, onInit, etc.)''':''' The object to which the entry belongs.		* '''Addon Config Files''' (e.g. UserActions, onInit, etc.)''':''' The object to which the entry belongs.
	* '''Dialogs:''' The player unit that activated control (e.g. via mouseEnter). [[false]] if non-activated.		* '''Dialogs:''' The player unit that activated control (e.g. via mouseEnter). [[false]] if non-activated.
Line 78:		Line 78:
	** ''Condition'', ''On Activation'' and ''On Deactivation'': The group leader that completed the waypoint (or the driver, if the waypoint is assigned to a vehicle).		** ''Condition'', ''On Activation'' and ''On Deactivation'': The group leader that completed the waypoint (or the driver, if the waypoint is assigned to a vehicle).

			=== thisList ===

	~~==== thisList ====~~
	* '''Triggers:'''		* '''Triggers:'''
	** Accessible in the ''Condition'', ''On Activation'' and ''On Deactivation'' code.		** Accessible in the ''Condition'', ''On Activation'' and ''On Deactivation'' code.
Line 88:		Line 88:
	** Defines an array containing all group members that completed the waypoint.		** Defines an array containing all group members that completed the waypoint.

			=== thisTrigger ===

	~~==== thisTrigger ====~~
	Refers to the [[Triggers\|trigger]] object itself - accessible within the ''Condition'', ''On Activation'' and ''On Deactivation'' code.		Refers to the [[Triggers\|trigger]] object itself - accessible within the ''Condition'', ''On Activation'' and ''On Deactivation'' code.

Lou Montana: Text replacement - "↵\{\{ConfigPage\| [a-zA-Z]+ \}\}" to ""

2025-04-12T22:20:53Z

Text replacement - "↵\{\{ConfigPage\| *[a-zA-Z]+ *\}\}" to ""

← Older revision		Revision as of 00:20, 13 April 2025
Line 5:		Line 5:


	~~{{ConfigPage\|start}}~~
	~~{{ConfigPage\|abc}}~~
	==== _this ====		==== _this ====
	Used to make the arguments of a script call ([[call]], [[exec]], [[execVM]], [[spawn]]) visible and accessible to the script. Also used by [[:Category:Event Handlers\|Event Handlers]] to provide parameters.		Used to make the arguments of a script call ([[call]], [[exec]], [[execVM]], [[spawn]]) visible and accessible to the script. Also used by [[:Category:Event Handlers\|Event Handlers]] to provide parameters.
Line 94:		Line 92:
	Refers to the [[Triggers\|trigger]] object itself - accessible within the ''Condition'', ''On Activation'' and ''On Deactivation'' code.		Refers to the [[Triggers\|trigger]] object itself - accessible within the ''Condition'', ''On Activation'' and ''On Deactivation'' code.

	~~{{ConfigPage\|end}}~~


	[[Category: Scripting Topics]]		[[Category: Scripting Topics]]

Lou Montana: Text replacement - "{{Feature|Warning|" to "{{Feature|warning|"

2024-02-01T23:24:57Z

Text replacement - "{{Feature|Warning|" to "{{Feature|warning|"

← Older revision		Revision as of 01:24, 2 February 2024
Line 66:		Line 66:

	==== _time ====		==== _time ====
	{{Feature\|~~Warning~~\|[[SQS Syntax\|SQS]] only.}}		{{Feature\|warning\|[[SQS Syntax\|SQS]] only.}}
	The time elapsed since the script started running.		The time elapsed since the script started running.

Lou Montana: Add ctrlAddEventHandler and displayAddEventHandler to _thisEventHandler and _thisEvent + reordering

2024-01-16T10:56:22Z

Add ctrlAddEventHandler and displayAddEventHandler to _thisEventHandler and _thisEvent + reordering

← Older revision		Revision as of 12:56, 16 January 2024
Line 21:		Line 21:
	{{ArgTitle\|4\|_exception\|{{GVI\|arma1\|1.00}}}}		{{ArgTitle\|4\|_exception\|{{GVI\|arma1\|1.00}}}}
	[[Exception handling]] using a [[try]]-[[catch]]-statement declares this variable which contains details about the [[throw\|thrown]] exception in the [[try]]-block.		[[Exception handling]] using a [[try]]-[[catch]]-statement declares this variable which contains details about the [[throw\|thrown]] exception in the [[try]]-block.


			{{ArgTitle\|4\|_fnc_scriptName\|{{GVI\|arma3\|1.00}}}}
			{{Feature\|informative\|Not engine-maintained, but added by {{hl\|functions_f/initFunctions.sqf}} – see [[scriptName]].}}
			Within a [[:Category:Functions\|Function]], the {{hl\|TAG_fnc_functionName}} function name (e.g. {{hl\|"myTag_fnc_myFunction"}}).


			{{ArgTitle\|4\|_fnc_scriptNameParent\|{{GVI\|arma3\|1.00}}}}
			{{Feature\|informative\|Not engine-maintained, but added by {{hl\|functions_f/initFunctions.sqf}} – see [[scriptName]].}}
			Within a [[:Category:Functions\|Function]], the name of the function that called the current function (same as [[#fnc_scriptName\|_fnc_scriptName]] if the function was not called by another function).


	{{ArgTitle\|4\|_forEachIndex\|{{GVI\|arma2oa\|1.55}}}}		{{ArgTitle\|4\|_forEachIndex\|{{GVI\|arma2oa\|1.55}}}}
	Represents the (zero-based) index of a [[forEach]]- / [[forEachReversed]]-loop.		Represents the (zero-based) index of a [[forEach]]- / [[forEachReversed]]-loop.


			{{ArgTitle\|4\|_self\|{{GVI\|arma3\|2.14}}}}
			Available in HashMapObject methods. Contains the HashMapObject instance that the method was invoked on (see [[createHashMapObject]]).


Line 31:		Line 45:


	{{ArgTitle\|4\|~~_thisEventHandler~~\|{{GVI\|arma3\|1.64}}}}		{{ArgTitle\|4\|_thisEvent\|{{GVI\|arma3\|2.06}}}}
	The ~~index for~~ Event ~~Handlers~~ added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]] or [[addUserActionEventHandler]].		The name of the Event added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]],[[addUserActionEventHandler]], [[ctrlAddEventHandler]] and [[displayAddEventHandler]], as well as for config types EHs.


	{{ArgTitle\|4\|~~_thisScriptedEventHandler~~\|{{GVI\|arma3\|1.68}}}}		{{ArgTitle\|4\|_thisEventHandler\|{{GVI\|arma3\|1.64}}}}
	The index for ~~Scripted~~ Event Handlers ~~added with [[BIS_fnc_addScriptedEventHandler]].~~		The index for Event Handlers added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]], [[addUserActionEventHandler]], [[ctrlAddEventHandler]] and [[displayAddEventHandler]].


	~~{{ArgTitle\|4\|_thisEvent\|{{GVI\|arma3\|2.06}}}}~~
	~~The name of the Event~~ added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]] or [[addUserActionEventHandler]], ~~as well as for config types EHs~~.


Line 49:		Line 59:
	{{ArgTitle\|4\|_thisScript\|{{GVI\|arma3\|1.54}}}}		{{ArgTitle\|4\|_thisScript\|{{GVI\|arma3\|1.54}}}}
	The [[Script Handle]] of a script started with [[execVM]], [[call]] or [[spawn]].		The [[Script Handle]] of a script started with [[execVM]], [[call]] or [[spawn]].


			{{ArgTitle\|4\|_thisScriptedEventHandler\|{{GVI\|arma3\|1.68}}}}
			The index for Scripted Event Handlers added with [[BIS_fnc_addScriptedEventHandler]].


Line 54:		Line 68:
	{{Feature\|Warning\|[[SQS Syntax\|SQS]] only.}}		{{Feature\|Warning\|[[SQS Syntax\|SQS]] only.}}
	The time elapsed since the script started running.		The time elapsed since the script started running.


	~~{{ArgTitle\|4\|_fnc_scriptName\|{{GVI\|arma3\|1.00}}}}~~
	~~{{Feature\|informative\|Not engine-maintained, but added by {{hl\|functions_f/initFunctions.sqf}} – see [[scriptName]].}}~~
	~~Within a [[:Category:Functions\|Function]], the {{hl\|TAG_fnc_functionName}} function name (e.g. {{hl\|"myTag_fnc_myFunction"}}).~~


	~~{{ArgTitle\|4\|_fnc_scriptNameParent\|{{GVI\|arma3\|1.00}}}}~~
	~~{{Feature\|informative\|Not engine-maintained, but added by {{hl\|functions_f/initFunctions.sqf}} – see [[scriptName]].}}~~
	~~Within a [[:Category:Functions\|Function]], the name of the function that called the current function (same as [[#fnc_scriptName\|_fnc_scriptName]] if the function was not called by another function).~~


	~~{{ArgTitle\|4\|_self\|{{GVI\|arma3\|2.14}}}}~~
	~~Available in HashMapObject methods. Contains the HashMapObject instance that the method was invoked on (see [[createHashMapObject]]).~~

Ansin11: Added _self

2023-10-07T12:12:07Z

Added _self

← Older revision		Revision as of 14:12, 7 October 2023
Line 1:		Line 1:
	{{TOC\|side}}		{{TOC\|side}}
	__NOEDITSECTION__		__NOEDITSECTION__
	~~'''~~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).		Magic variables are engine-maintained [[Variables\|variables]] that serve a specific purpose within a given scope and are often used by the engine to provide data to a [[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).


Line 7:		Line 8:
	{{ConfigPage\|abc}}		{{ConfigPage\|abc}}
	==== _this ====		==== _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~~.		Used to make the arguments of a script call ([[call]], [[exec]], [[execVM]], [[spawn]]) visible and accessible to the script. Also used by [[:Category:Event Handlers\|Event Handlers]] to provide parameters.


	==== _x ====		==== _x ====
	Represents the current element during ~~a loop~~ with: [[apply]], [[count]], [[configClasses]], [[configProperties]], [[findIf]], [[forEach]], [[select]].		Represents the current element during iteration with [[apply]], [[count]], [[configClasses]], [[configProperties]], [[findIf]], [[forEach]] and [[select]].


Line 19:		Line 20:

	{{ArgTitle\|4\|_exception\|{{GVI\|arma1\|1.00}}}}		{{ArgTitle\|4\|_exception\|{{GVI\|arma1\|1.00}}}}
	[[Exception handling]] using a [[try]]-[[catch]] statement declares this variable which contains details about the [[throw\|thrown]] exception in the try block.		[[Exception handling]] using a [[try]]-[[catch]]-statement declares this variable which contains details about the [[throw\|thrown]] exception in the [[try]]-block.


	{{ArgTitle\|4\|_forEachIndex\|{{GVI\|arma2oa\|1.55}}}}		{{ArgTitle\|4\|_forEachIndex\|{{GVI\|arma2oa\|1.55}}}}
	Represents the (zero-based) index of a [[forEach]]/[[forEachReversed]] ~~[[#x\|_x]] element~~.		Represents the (zero-based) index of a [[forEach]]- / [[forEachReversed]]-loop.


	{{ArgTitle\|4\|_thisArgs\|{{GVI\|arma3\|2.04}}}}		{{ArgTitle\|4\|_thisArgs\|{{GVI\|arma3\|2.04}}}}
	Additional Event Handler arguments available with [[addMissionEventHandler]]		Additional Event Handler arguments available with [[addMissionEventHandler]].


Line 43:		Line 44:

	{{ArgTitle\|4\|_thisFSM\|{{GVI\|arma3\|1.54}}}}		{{ArgTitle\|4\|_thisFSM\|{{GVI\|arma3\|1.54}}}}
	The [[FSM]] id for FSMs executed with [[execFSM]].		The [[FSM]] ID for FSMs executed with [[execFSM]].


	{{ArgTitle\|4\|_thisScript\|{{GVI\|arma3\|1.54}}}}		{{ArgTitle\|4\|_thisScript\|{{GVI\|arma3\|1.54}}}}
	The [[execVM]]ed, [[call]]ed or [[spawn]]~~ed [[Script Handle\|script handle]] from within itself~~.		The [[Script Handle]] of a script started with [[execVM]], [[call]] or [[spawn]].


	==== _time ====		==== _time ====
	~~'''~~[[SQS Syntax\|SQS]] ~~ONLY~~.~~'''~~ The time elapsed since the script started running.		{{Feature\|Warning\|[[SQS Syntax\|SQS]] only.}}
			The time elapsed since the script started running.


	{{ArgTitle\|4\|_fnc_scriptName\|{{GVI\|arma3\|1.00}}}}		{{ArgTitle\|4\|_fnc_scriptName\|{{GVI\|arma3\|1.00}}}}
	{{Feature\|informative\|~~not~~ engine-maintained, but added by functions_f/~~'''~~initFunctions.sqf~~''' script~~ – see [[scriptName]]}}		{{Feature\|informative\|Not engine-maintained, but added by {{hl\|functions_f/initFunctions.sqf}} – see [[scriptName]].}}
	~~From within~~ a [[:Category:Functions\|Function]], the ~~'''~~TAG_fnc_functionName~~'''~~ function name ~~as string~~ (e.g. "myTag_fnc_myFunction")		Within a [[:Category:Functions\|Function]], the {{hl\|TAG_fnc_functionName}} function name (e.g. {{hl\|"myTag_fnc_myFunction"}}).


	{{ArgTitle\|4\|_fnc_scriptNameParent\|{{GVI\|arma3\|1.00}}}}		{{ArgTitle\|4\|_fnc_scriptNameParent\|{{GVI\|arma3\|1.00}}}}
	{{Feature\|informative\|~~not~~ engine-maintained, but added by functions_f/~~'''~~initFunctions.sqf~~''' script~~ – see [[scriptName]]}}		{{Feature\|informative\|Not engine-maintained, but added by {{hl\|functions_f/initFunctions.sqf}} – see [[scriptName]].}}
	~~From within~~ a [[:Category:Functions\|Function]], name of the function that called the current ~~one~~ ([[#fnc_scriptName\|_fnc_scriptName]] ~~used when~~ not ~~defined~~)		Within a [[:Category:Functions\|Function]], the name of the function that called the current function (same as [[#fnc_scriptName\|_fnc_scriptName]] if the function was not called by another function).


			{{ArgTitle\|4\|_self\|{{GVI\|arma3\|2.14}}}}
			Available in HashMapObject methods. Contains the HashMapObject instance that the method was invoked on (see [[createHashMapObject]]).


	==== this ====		==== this ====
	* '''~~In Addons' config files~~''' (e.g. UserActions, onInit, etc.): The object to which the entry belongs		* '''Addon 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		* '''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		* '''Object Init Fields:''' The object to which the init field belongs.
	* '''In Triggers'''		* '''Triggers:'''
	** ''"Condition~~" line~~'': The [[Boolean]] return value of the [[~~Mission Editor: Triggers\|trigger~~]]'s ~~conditions~~ (e.g. "East Not Present" ~~etc~~)		** ''Condition'': The [[Boolean]] return value of the [[Trigger]]'s condition (e.g. "East Not Present").
	** ''"On Activation/Deactivation~~" line~~'': Seems to always return [[false]]		** ''On Activation'' and ''On Deactivation'': Seems to always return [[false]].
	* '''In Waypoints'''		* '''Waypoints:'''
	** ''"Condition~~" or "~~On Activation/Deactivation~~" line~~'': The group leader that completed the ~~respective~~ waypoint (or driver, if waypoint is assigned to a vehicle)		** ''Condition'', ''On Activation'' and ''On Deactivation'': The group leader that completed the waypoint (or the driver, if the waypoint is assigned to a vehicle).


	==== thisList ====		==== thisList ====
	~~[[Variables\|Variable]] defined by [[Triggers]] and [[Waypoints]]:~~		* '''Triggers:'''
	* Triggers:		** Accessible in the ''Condition'', ''On Activation'' and ''On Deactivation'' code.
	** ~~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).
	** ~~defines~~ an array of objects that have been detected by the trigger (same as what is returned by the [[list]] command)		** Seems to be undefined in the ''On Deactivation'' expression and should not be used. It will either be 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'' code.
	** ~~accessible~~ within the '''Condition''' or '''On Activation''~~' script~~		** Defines an array containing all group members that completed the waypoint.
	** ~~defines~~ an array containing all group members that completed the ~~respective~~ waypoint


	==== thisTrigger ====		==== thisTrigger ====
	Refers to the [[Triggers\|trigger]] object itself - accessible within the '''Condition''', '''On Activation''~~' or '~~''On Deactivation''~~' script~~.		Refers to the [[Triggers\|trigger]] object itself - accessible within the ''Condition'', ''On Activation'' and ''On Deactivation'' code.

	{{ConfigPage\|end}}		{{ConfigPage\|end}}

Lou Montana: Add _forEachIndex version

2023-04-20T21:29:26Z

Add _forEachIndex version

← Older revision		Revision as of 23:29, 20 April 2023
Line 22:		Line 22:


	~~====~~ _forEachIndex ~~====~~		{{ArgTitle\|4\|_forEachIndex\|{{GVI\|arma2oa\|1.55}}}}
	Represents the (zero-based) index of a [[forEach]] [[#x\|_x]] element.		Represents the (zero-based) index of a [[forEach]]/[[forEachReversed]] [[#x\|_x]] element.

Lou Montana: Fix _thisEventHandler version

2023-03-28T21:42:28Z

Fix _thisEventHandler version

← Older revision		Revision as of 23:42, 28 March 2023
Line 30:		Line 30:


	{{ArgTitle\|4\|_thisEventHandler\|{{GVI\|arma3\|1.54}}}}		{{ArgTitle\|4\|_thisEventHandler\|{{GVI\|arma3\|1.64}}}}
	The index for Event Handlers added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]] or [[addUserActionEventHandler]].		The index for Event Handlers added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]] or [[addUserActionEventHandler]].

Line 55:		Line 55:

	{{ArgTitle\|4\|_fnc_scriptName\|{{GVI\|arma3\|1.00}}}}		{{ArgTitle\|4\|_fnc_scriptName\|{{GVI\|arma3\|1.00}}}}
	{{Feature\|~~Informative~~\|not engine-maintained, but added by functions_f/'''initFunctions.sqf''' script – see [[scriptName]]}}		{{Feature\|informative\|not engine-maintained, but added by functions_f/'''initFunctions.sqf''' script – see [[scriptName]]}}
	From within a [[:Category:Functions\|Function]], the '''TAG_fnc_functionName''' function name as string (e.g. "myTag_fnc_myFunction")		From within a [[:Category:Functions\|Function]], the '''TAG_fnc_functionName''' function name as string (e.g. "myTag_fnc_myFunction")


	{{ArgTitle\|4\|_fnc_scriptNameParent\|{{GVI\|arma3\|1.00}}}}		{{ArgTitle\|4\|_fnc_scriptNameParent\|{{GVI\|arma3\|1.00}}}}
	{{Feature\|~~Informative~~\|not engine-maintained, but added by functions_f/'''initFunctions.sqf''' script – see [[scriptName]]}}		{{Feature\|informative\|not engine-maintained, but added by functions_f/'''initFunctions.sqf''' script – see [[scriptName]]}}
	From within a [[:Category:Functions\|Function]], name of the function that called the current one ([[#fnc_scriptName\|_fnc_scriptName]] used when not defined)		From within a [[:Category:Functions\|Function]], name of the function that called the current one ([[#fnc_scriptName\|_fnc_scriptName]] used when not defined)

Leopard20 at 12:51, 17 February 2022

2022-02-17T12:51:14Z

← Older revision		Revision as of 14:51, 17 February 2022
Line 39:		Line 39:

	{{ArgTitle\|4\|_thisEvent\|{{GVI\|arma3\|2.06}}}}		{{ArgTitle\|4\|_thisEvent\|{{GVI\|arma3\|2.06}}}}
	The name of the Event added with [[addEventHandler]], [[addMPEventHandler]] or [[~~addMissionEventHandler~~]] as well as for config types EHs.		The name of the Event added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]] or [[addUserActionEventHandler]], as well as for config types EHs.

Leopard20 at 12:07, 17 February 2022

2022-02-17T12:07:49Z

← Older revision		Revision as of 14:07, 17 February 2022
Line 31:		Line 31:

	{{ArgTitle\|4\|_thisEventHandler\|{{GVI\|arma3\|1.54}}}}		{{ArgTitle\|4\|_thisEventHandler\|{{GVI\|arma3\|1.54}}}}
	The index for Event Handlers added with [[addEventHandler]], [[addMPEventHandler]] or [[~~addMissionEventHandler~~]].		The index for Event Handlers added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]] or [[addUserActionEventHandler]].

Leopard20 at 09:25, 17 February 2022

2022-02-17T09:25:51Z

← Older revision		Revision as of 11:25, 17 February 2022
Line 34:		Line 34:


	{{ArgTitle\|4\|_thisScriptedEventHandler\|{{GVI\|arma3\|1.00}}}}		{{ArgTitle\|4\|_thisScriptedEventHandler\|{{GVI\|arma3\|1.68}}}}
	The index for Scripted Event Handlers added with [[BIS_fnc_addScriptedEventHandler]].		The index for Scripted Event Handlers added with [[BIS_fnc_addScriptedEventHandler]].

← Older revision		Revision as of 12:56, 16 January 2024
Line 21:		Line 21:
	{{ArgTitle\|4\|_exception\|{{GVI\|arma1\|1.00}}}}		{{ArgTitle\|4\|_exception\|{{GVI\|arma1\|1.00}}}}
	[[Exception handling]] using a [[try]]-[[catch]]-statement declares this variable which contains details about the [[throw\|thrown]] exception in the [[try]]-block.		[[Exception handling]] using a [[try]]-[[catch]]-statement declares this variable which contains details about the [[throw\|thrown]] exception in the [[try]]-block.


			{{ArgTitle\|4\|_fnc_scriptName\|{{GVI\|arma3\|1.00}}}}
			{{Feature\|informative\|Not engine-maintained, but added by {{hl\|functions_f/initFunctions.sqf}} – see [[scriptName]].}}
			Within a [[:Category:Functions\|Function]], the {{hl\|TAG_fnc_functionName}} function name (e.g. {{hl\|"myTag_fnc_myFunction"}}).


			{{ArgTitle\|4\|_fnc_scriptNameParent\|{{GVI\|arma3\|1.00}}}}
			{{Feature\|informative\|Not engine-maintained, but added by {{hl\|functions_f/initFunctions.sqf}} – see [[scriptName]].}}
			Within a [[:Category:Functions\|Function]], the name of the function that called the current function (same as [[#fnc_scriptName\|_fnc_scriptName]] if the function was not called by another function).


	{{ArgTitle\|4\|_forEachIndex\|{{GVI\|arma2oa\|1.55}}}}		{{ArgTitle\|4\|_forEachIndex\|{{GVI\|arma2oa\|1.55}}}}
	Represents the (zero-based) index of a [[forEach]]- / [[forEachReversed]]-loop.		Represents the (zero-based) index of a [[forEach]]- / [[forEachReversed]]-loop.


			{{ArgTitle\|4\|_self\|{{GVI\|arma3\|2.14}}}}
			Available in HashMapObject methods. Contains the HashMapObject instance that the method was invoked on (see [[createHashMapObject]]).


Line 31:		Line 45:


	{{ArgTitle\|4\|~~_thisEventHandler~~\|{{GVI\|arma3\|1.64}}}}		{{ArgTitle\|4\|_thisEvent\|{{GVI\|arma3\|2.06}}}}
	The ~~index for~~ Event ~~Handlers~~ added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]] or [[addUserActionEventHandler]].		The name of the Event added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]],[[addUserActionEventHandler]], [[ctrlAddEventHandler]] and [[displayAddEventHandler]], as well as for config types EHs.


	{{ArgTitle\|4\|~~_thisScriptedEventHandler~~\|{{GVI\|arma3\|1.68}}}}		{{ArgTitle\|4\|_thisEventHandler\|{{GVI\|arma3\|1.64}}}}
	The index for ~~Scripted~~ Event Handlers ~~added with [[BIS_fnc_addScriptedEventHandler]].~~		The index for Event Handlers added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]], [[addUserActionEventHandler]], [[ctrlAddEventHandler]] and [[displayAddEventHandler]].


	~~{{ArgTitle\|4\|_thisEvent\|{{GVI\|arma3\|2.06}}}}~~
	~~The name of the Event~~ added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]] or [[addUserActionEventHandler]], ~~as well as for config types EHs~~.


Line 49:		Line 59:
	{{ArgTitle\|4\|_thisScript\|{{GVI\|arma3\|1.54}}}}		{{ArgTitle\|4\|_thisScript\|{{GVI\|arma3\|1.54}}}}
	The [[Script Handle]] of a script started with [[execVM]], [[call]] or [[spawn]].		The [[Script Handle]] of a script started with [[execVM]], [[call]] or [[spawn]].


			{{ArgTitle\|4\|_thisScriptedEventHandler\|{{GVI\|arma3\|1.68}}}}
			The index for Scripted Event Handlers added with [[BIS_fnc_addScriptedEventHandler]].


Line 54:		Line 68:
	{{Feature\|Warning\|[[SQS Syntax\|SQS]] only.}}		{{Feature\|Warning\|[[SQS Syntax\|SQS]] only.}}
	The time elapsed since the script started running.		The time elapsed since the script started running.


	~~{{ArgTitle\|4\|_fnc_scriptName\|{{GVI\|arma3\|1.00}}}}~~
	~~{{Feature\|informative\|Not engine-maintained, but added by {{hl\|functions_f/initFunctions.sqf}} – see [[scriptName]].}}~~
	~~Within a [[:Category:Functions\|Function]], the {{hl\|TAG_fnc_functionName}} function name (e.g. {{hl\|"myTag_fnc_myFunction"}}).~~


	~~{{ArgTitle\|4\|_fnc_scriptNameParent\|{{GVI\|arma3\|1.00}}}}~~
	~~{{Feature\|informative\|Not engine-maintained, but added by {{hl\|functions_f/initFunctions.sqf}} – see [[scriptName]].}}~~
	~~Within a [[:Category:Functions\|Function]], the name of the function that called the current function (same as [[#fnc_scriptName\|_fnc_scriptName]] if the function was not called by another function).~~


	~~{{ArgTitle\|4\|_self\|{{GVI\|arma3\|2.14}}}}~~
	~~Available in HashMapObject methods. Contains the HashMapObject instance that the method was invoked on (see [[createHashMapObject]]).~~

← Older revision		Revision as of 23:42, 28 March 2023
Line 30:		Line 30:


	{{ArgTitle\|4\|_thisEventHandler\|{{GVI\|arma3\|1.54}}}}		{{ArgTitle\|4\|_thisEventHandler\|{{GVI\|arma3\|1.64}}}}
	The index for Event Handlers added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]] or [[addUserActionEventHandler]].		The index for Event Handlers added with [[addEventHandler]], [[addMPEventHandler]], [[addMissionEventHandler]] or [[addUserActionEventHandler]].

Line 55:		Line 55:

	{{ArgTitle\|4\|_fnc_scriptName\|{{GVI\|arma3\|1.00}}}}		{{ArgTitle\|4\|_fnc_scriptName\|{{GVI\|arma3\|1.00}}}}
	{{Feature\|~~Informative~~\|not engine-maintained, but added by functions_f/'''initFunctions.sqf''' script – see [[scriptName]]}}		{{Feature\|informative\|not engine-maintained, but added by functions_f/'''initFunctions.sqf''' script – see [[scriptName]]}}
	From within a [[:Category:Functions\|Function]], the '''TAG_fnc_functionName''' function name as string (e.g. "myTag_fnc_myFunction")		From within a [[:Category:Functions\|Function]], the '''TAG_fnc_functionName''' function name as string (e.g. "myTag_fnc_myFunction")


	{{ArgTitle\|4\|_fnc_scriptNameParent\|{{GVI\|arma3\|1.00}}}}		{{ArgTitle\|4\|_fnc_scriptNameParent\|{{GVI\|arma3\|1.00}}}}
	{{Feature\|~~Informative~~\|not engine-maintained, but added by functions_f/'''initFunctions.sqf''' script – see [[scriptName]]}}		{{Feature\|informative\|not engine-maintained, but added by functions_f/'''initFunctions.sqf''' script – see [[scriptName]]}}
	From within a [[:Category:Functions\|Function]], name of the function that called the current one ([[#fnc_scriptName\|_fnc_scriptName]] used when not defined)		From within a [[:Category:Functions\|Function]], name of the function that called the current one ([[#fnc_scriptName\|_fnc_scriptName]] used when not defined)