BIS fnc addStackedEventHandler: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) (Add correspondence table + obsolete message) |
Lou Montana (talk | contribs) m (Text replacement - "<tt>([a-zA-Z0-9\. _"\\']+)<\/tt>" to "{{hl|$1}}") |
||
| Line 11: | Line 11: | ||
|descr= {{Feature|obsolete|[[Arma 3: Mission Event Handlers]] should be used instead.|arma3|1.58}} | |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 | 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. | ||
{{{!}} class="wikitable" | {{{!}} class="wikitable" | ||
| Line 25: | Line 25: | ||
{{!}} "[[onPlayerConnected]]" | {{!}} "[[onPlayerConnected]]" | ||
{{!}} [[Arma 3: Mission Event Handlers#PlayerConnected|PlayerConnected]] | {{!}} [[Arma 3: Mission Event Handlers#PlayerConnected|PlayerConnected]] | ||
{{!}} rowspan="2" {{!}}Special variables | {{!}} 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. | ||
<syntaxhighlight lang="cpp">params ["_id", "_uid", "_name", "_jip", "_owner"];</syntaxhighlight> | <syntaxhighlight lang="cpp">params ["_id", "_uid", "_name", "_jip", "_owner"];</syntaxhighlight> | ||
{{!}}- | {{!}}- | ||
| Line 33: | Line 33: | ||
{{!}} "[[onMapSingleClick]]" | {{!}} "[[onMapSingleClick]]" | ||
{{!}} [[Arma 3: Mission Event Handlers#MapSingleClick|MapSingleClick]] | {{!}} [[Arma 3: Mission Event Handlers#MapSingleClick|MapSingleClick]] | ||
{{!}} Special variables | {{!}} Special variables {{hl|_units}}, {{hl|_pos}}, {{hl|_alt}}, {{hl|_shift}} are provided and are available in {{hl|_this}} array as well. | ||
<syntaxhighlight lang="cpp">params ["_units", "_pos", "_alt", "_shift"];</syntaxhighlight> | <syntaxhighlight lang="cpp">params ["_units", "_pos", "_alt", "_shift"];</syntaxhighlight> | ||
{{!}}- | {{!}}- | ||
| Line 53: | Line 53: | ||
|p3= code: [[Code]] or [[String]]. The [[String]] is treated as function name | |p3= code: [[Code]] or [[String]]. The [[String]] is treated as function name | ||
|p4= arguments: [[Array]] of [[Anything]] - arguments to make available in code in | |p4= arguments: [[Array]] of [[Anything]] - arguments to make available in code in {{hl|_this}} array | ||
|r1= [[String]] - custom id on success or "" on failure | |r1= [[String]] - custom id on success or "" on failure | ||
Revision as of 23:55, 15 November 2021
Description
- Description:
-
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
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
- Posted on 25 Jun, 2014
- ffur2007slx2_5
-
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..var100]; // pretty demanding[_id, "onEachFrame", { { _x call _code } forEach [var0..var100]; }] call BIS_fnc_addStackedEventHandler; // faster, only one event