BIS fnc callScriptedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)<nowiki>\[<\/nowiki>\[\[([a-zA-Z0-9_]+)\]\](.*)<\/code>" to "<code>$1$2$3</code>")
m (Some wiki formatting)
 
Line 16: Line 16:
|p3= arguments: [[Array]] - array of arguments passed to the EH code
|p3= arguments: [[Array]] - array of arguments passed to the EH code


|p4= returnResults (Optional): [[Boolean]] - if [[true]] EH will place results from each code execution into an array using EH id as index. Default: [[false]]
|p4= returnResults: [[Boolean]] - (Optional, default [[false]]) if [[true]] EH will place results from each code execution into an array using EH id as index


|r1= [[Array]] - array with EH results or empty array
|r1= [[Array]] - array with EH results or empty array


|x1= <code>missionNamespace, "event", [<nowiki/>[[player]], 123]] [[call]] [[BIS_fnc_callScriptedEventHandler]];</code>
|x1= <sqf>[missionNamespace, "event", [player, 123]] call BIS_fnc_callScriptedEventHandler;</sqf>
 
|seealso= [[BIS_fnc_addScriptedEventHandler]] [[BIS_fnc_removeScriptedEventHandler]] [[BIS_fnc_removeAllScriptedEventHandlers]]
|seealso= [[BIS_fnc_addScriptedEventHandler]] [[BIS_fnc_removeScriptedEventHandler]] [[BIS_fnc_removeAllScriptedEventHandlers]]
}}
}}

Latest revision as of 13:24, 13 July 2022

Hover & click on the images for description

Description

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

Syntax

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: Boolean - (Optional, default false) if true EH will place results from each code execution into an array using EH id as index
Return Value:
Array - array with EH results or empty array

Examples

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

Additional Information

See also:
BIS_fnc_addScriptedEventHandler BIS_fnc_removeScriptedEventHandler BIS_fnc_removeAllScriptedEventHandlers

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