BIS fnc addStackedEventHandler: Difference between revisions

Latest revision as of 17:06, 1 November 2022

1.00

LELocal

Hover & click on the images for description

Description

Description:

🕖

This information is obsolete as of Arma 3 v1.58. Reason: Arma 3: Mission Event Handlers should be used instead.

Stacks an event handler. All event handlers accept user arguments, which are passed to the EH code in _this variable. If the EH has own params returned in _this variable as well, user arguments are appended to the end of _this array. Note that if you try to add an empty EH, i.e. with empty code, it will simply be ignored.

Supported Event Handlers
Scripted Event Handler	Mission EH Equivalent	Description
"onEachFrame"	EachFrame	N/A
"onPlayerConnected"	PlayerConnected	Special variables `_id`, `_uid`, `_name`, `_jip`, `_owner` are provided and are available in `_this` array as well. params ["_id", "_uid", "_name", "_jip", "_owner"];
"onPlayerDisconnected"	PlayerDisconnected
"onMapSingleClick"	MapSingleClick	Special variables `_units`, `_pos`, `_alt`, `_shift` are provided and are available in `_this` array as well. params ["_units", "_pos", "_alt", "_shift"];
"onPreloadStarted"	PreloadStarted	N/A
"onPreloadFinished"	PreloadFinished	N/A

Execution:

call

Multiplayer:

This command has the same locality as addMissionEventHandler.

Groups:

Event Handlers

Syntax

Syntax:: [id, event, code, arguments] call BIS_fnc_addStackedEventHandler
Parameters:: id: String - custom id, a unique identifier. Adding same type of EH with the same id will overwrite existing
: event: String - event handler name, see description for supported EHs
: code: Code or String. The String is treated as function name
: arguments: Array of Anything - arguments to make available in code in _this array
Return Value:: String - custom id on success or "" on failure

Examples

Example 1:: ["someId", "onEachFrame", { hintSilent str time }] call BIS_fnc_addStackedEventHandler;
Example 2:: ["someId", "onEachFrame", {hintSilent str position (_this select 0)}, [player]] call BIS_fnc_addStackedEventHandler;
Example 3:: private _eventName = "OnEachFrame"; missionNamespace getVariable [format ["BIS_stackedEventHandlers_%1", _eventName], []]; // gets an array with all existing ids

Additional Information

See also:: addMissionEventHandler BIS_fnc_removeStackedEventHandler

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

ffur2007slx2_5 - c: Posted on Jun 25, 2014 - 12:08 (UTC)
: Stacking all the code into one PFH will be less demanding than separated calling within multiple PFH, e.g:
{ [format ["%1", _forEachIndex], "onEachFrame", _code, [_x]] call BIS_fnc_addStackedEventHandler; } forEach [var0, var1, varN, var100]; // pretty demanding

[_id, "onEachFrame", { { _x call _code } forEach [var0, var1, varN, var100]; }] call BIS_fnc_addStackedEventHandler; // faster, only one event

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Event Handlers
-|1.00|= Game version
+|eff= local
-____________________________________________________________________________________________
-| <pre>/*
+|mp= This command has the same locality as [[addMissionEventHandler]].
-	Description:
-	This function adds a new item that will be stacked and called upon event handler selected has been executed
-	Parameter(s):
-	_this select 0:	STRING		- The unique ID of the item inside the stack
-	_this select 1:	STRING		- The onXxx event handler to monitor and execute code upon
-	_this select 2:	STRING or CODE	- The function name or code to execute upon the event triggering
-	_this select 3:	ANY		- Arguments passed to function/code
-	Returns:
-	STRING - The stacked item ID
-*/
-//Parameters
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_addStackedEventHandler]]; --> |= Syntax
+|descr= {{Feature|obsolete|[[Arma 3: Mission Event Handlers]] should be used instead.|arma3|1.58}}
+Stacks an event handler.  All event handlers accept user arguments, which are passed to the EH code in {{hl|_this}} variable. If the EH has own params returned in {{hl|_this}} variable as well, user arguments are appended to the end of {{hl|_this}} array. Note that if you try to add an empty EH, i.e. with empty code, it will simply be ignored.
-|p1= |= Parameter 1
+{{{!}} class="wikitable"
+{{!}}+ Supported Event Handlers
+! Scripted Event Handler
+! Mission EH Equivalent
+! Description
+{{!}}-
+{{!}} "[[onEachFrame]]"
+{{!}} [[Arma 3: Mission Event Handlers#EachFrame|EachFrame]]
+{{!}} {{n/a}}
+{{!}}-
+{{!}} "[[onPlayerConnected]]"
+{{!}} [[Arma 3: Mission Event Handlers#PlayerConnected|PlayerConnected]]
+{{!}} rowspan="2" {{!}}Special variables {{hl|_id}}, {{hl|_uid}}, {{hl|_name}}, {{hl|_jip}}, {{hl|_owner}} are provided and are available in {{hl|_this}} array as well.
+<sqf>params ["_id", "_uid", "_name", "_jip", "_owner"];</sqf>
+{{!}}-
+{{!}} "[[onPlayerDisconnected]]"
+{{!}} [[Arma 3: Mission Event Handlers#PlayerDisconnected|PlayerDisconnected]]
+{{!}}-
+{{!}} "[[onMapSingleClick]]"
+{{!}} [[Arma 3: Mission Event Handlers#MapSingleClick|MapSingleClick]]
+{{!}} Special variables {{hl|_units}}, {{hl|_pos}}, {{hl|_alt}}, {{hl|_shift}} are provided and are available in {{hl|_this}} array as well.
+<sqf>params ["_units", "_pos", "_alt", "_shift"];</sqf>
+{{!}}-
+{{!}} "[[onPreloadStarted]]"
+{{!}} [[Arma 3: Mission Event Handlers#PreloadStarted|PreloadStarted]]
+{{!}} {{n/a}}
+{{!}}-
+{{!}} "[[onPreloadFinished]]"
+{{!}} [[Arma 3: Mission Event Handlers#PreloadFinished|PreloadFinished]]
+{{!}} {{n/a}}
+{{!}}}
-| |= Return value
+|s1= [id, event, code, arguments] call [[BIS_fnc_addStackedEventHandler]]
-____________________________________________________________________________________________
-|x1= <code></code> |=
+|p1= id: [[String]] - custom id, a unique identifier. Adding same type of EH with the same id will overwrite existing
-____________________________________________________________________________________________
-| |= See also
+|p2= event: [[String]] - event handler name, see description for supported EHs
-}}
+|p3= code: [[Code]] or [[String]]. The [[String]] is treated as function name
+|p4= arguments: [[Array]] of [[Anything]] - arguments to make available in code in {{hl|_this}} array
+|r1= [[String]] - custom id on success or "" on failure
+|x1= <sqf>["someId", "onEachFrame", { hintSilent str time }] call BIS_fnc_addStackedEventHandler;</sqf>
+|x2= <sqf>["someId", "onEachFrame", {hintSilent str position (_this select 0)}, [player]] call BIS_fnc_addStackedEventHandler;</sqf>
-<h3 style="display:none">Notes</h3>
+|x3= <sqf>
-<dl class="command_description">
+private _eventName = "OnEachFrame";
-<!-- Note Section BEGIN -->
+missionNamespace getVariable [format ["BIS_stackedEventHandlers_%1", _eventName], []]; // gets an array with all existing ids
+</sqf>
-<!-- Note Section END -->
+|seealso= [[addMissionEventHandler]] [[BIS_fnc_removeStackedEventHandler]]
-</dl>
+}}
-<h3 style="display:none">Bottom Section</h3>
+{{Note
-[[Category:Function Group: Misc|{{uc:addStackedEventHandler}}]]
+|user= ffur2007slx2_5
-[[Category:Functions|{{uc:addStackedEventHandler}}]]
+|timestamp= 20140625120800
-[[Category:{{Name|arma3}}: Functions|{{uc:addStackedEventHandler}}]]
+|text= Stacking all the code into one PFH will be less demanding than separated calling within multiple PFH, e.g:
+<sqf>
+{
+	[format ["%1", _forEachIndex], "onEachFrame", _code, [_x]] call BIS_fnc_addStackedEventHandler;
+} forEach [var0, var1, varN, var100]; // pretty demanding
+</sqf>
+<sqf>
+[_id, "onEachFrame", {
+	{ _x call _code } forEach [var0, var1, varN, var100];
+}] call BIS_fnc_addStackedEventHandler; // faster, only one event
+</sqf>
+}}