BIS fnc callScriptedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= |p2=" to "|Parameter1= |p2=")
m (Text replacement - "|= |p3=" to "|Parameter2= |p3=")
Line 14: Line 14:


|p1= namespace: [[Namespace]], [[Object]], [[Group]], [[Location]], [[Boolean]], [[Control]] or [[Display]] - namespace in which handler is saved|Parameter1=
|p1= namespace: [[Namespace]], [[Object]], [[Group]], [[Location]], [[Boolean]], [[Control]] or [[Display]] - namespace in which handler is saved|Parameter1=
|p2= name: [[String]] - handler name|=
|p2= name: [[String]] - handler name|Parameter2=
 
|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 (Optional): [[Boolean]] - if [[true]] EH will place results from each code execution into an array using EH id as index. Default: [[false]] |=

Revision as of 04:04, 3 September 2019


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.67 the code receives current EH id in the special variable: _thisScriptedEventHandler
Execution:
call
Groups:
Uncategorised

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 (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

Examples

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

Additional Information

See also:
BIS_fnc_addScriptedEventHandlerBIS_fnc_removeScriptedEventHandlerBIS_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

Notes

Bottom Section