BIS fnc addStackedEventHandler

1.00

LELocal

Hover & click on the images for description

Description

Description:

🕖

The following 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