Also available as Markdown and JSON, or read the original wiki page.
Warning
This function is deprecated.
Caution
This information is obsolete. 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.sqf |
|
| "onPlayerDisconnected" | PlayerDisconnected | ||
| "onMapSingleClick" | MapSingleClick | Special variables _units, _pos, _alt, _shift are provided and are available in _this array as well.sqf |
|
| "onPreloadStarted" | PreloadStarted | N/A | |
| "onPreloadFinished" | PreloadFinished | N/A |
[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 existingevent: String - event handler name, see description for supported EHscode: Code or String. The String is treated as function namearguments: Array of Anything - arguments to make available in code in _this arrayReturns: String - custom id on success or "" on failure
["someId", "onEachFrame", { hintSilent str time }] call BIS_fnc_addStackedEventHandler;
["someId", "onEachFrame", {hintSilent str position (_this select 0)}, [player]] call BIS_fnc_addStackedEventHandler;
private _eventName = "OnEachFrame";
missionNamespace getVariable [format ["BIS_stackedEventHandlers_%1", _eventName], []]; // gets an array with all existing ids
This command has the same locality as addMissionEventHandler.
addMissionEventHandler · BIS_fnc_removeStackedEventHandler
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