BIS fnc callScriptedEventHandler: Difference between revisions

Revision as of 23:28, 7 August 2021

Hover & click on the images for description

Description:: Calls all the codes assigned to scripted event handler with given name. Since 1.68 the code receives current EH id in the special variable: _thisScriptedEventHandler
Execution:: call
Groups:: Event Handlers

Syntax:: [namespace, name, arguments, returnResults] call BIS_fnc_callScriptedEventHandler
Parameters:: namespace: Namespace, Object, Group, Location, Boolean, Control or Display - namespace in which handler is saved
: name: String - handler name
: arguments: Array - array of arguments passed to the EH code
: returnResults (Optional): Boolean - if true EH will place results from each code execution into an array using EH id as index. Default: false
Return Value:: Array - array with EH results or empty array

Example 1:: [missionNamespace, "event", [player, 123]] call BIS_fnc_callScriptedEventHandler;

See also:: BIS_fnc_addScriptedEventHandler BIS_fnc_removeScriptedEventHandler BIS_fnc_removeAllScriptedEventHandlers

: 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

@@ Line 18: / Line 18: @@
 |p4= returnResults (Optional): [[Boolean]] - if [[true]] EH will place results from each code execution into an array using EH id as index. Default: [[false]]
-|r1=[[Array]] - array with EH results or empty array
+|r1= [[Array]] - array with EH results or empty array
 |x1= <code><nowiki>[</nowiki>[[missionNamespace]], "event", [<nowiki/>[[player]], 123]] [[call]] [[BIS_fnc_callScriptedEventHandler]];</code>
 |seealso= [[BIS_fnc_addScriptedEventHandler]], [[BIS_fnc_removeScriptedEventHandler]], [[BIS_fnc_removeAllScriptedEventHandlers]]
 }}