BIS fnc callScriptedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *(\[[a-zA-Z,. ]*\] call ('''|\[\[)?BI(N|S)_fnc_[a-zA-Z]+('''|\]\])?) * \|p1=" to " |s1=$1 |p1=")
m (Text replacement - "\| *(arg|eff|mp|serverExec|gr[0-9]) *= *(.*) * *\|([^=]{12})" to "|$1=$2 |descr=$3")
Line 7: Line 7:
|gr1= Event Handlers
|gr1= Event Handlers


| Calls all the codes assigned to scripted event handler with given name. Since {{GVI|arma3|1.68}} the code receives current EH id in the special variable: <tt>_thisScriptedEventHandler</tt>
|descr= Calls all the codes assigned to scripted event handler with given name. Since {{GVI|arma3|1.68}} the code receives current EH id in the special variable: <tt>_thisScriptedEventHandler</tt>


|s1=[namespace, name, arguments, returnResults] call [[BIS_fnc_callScriptedEventHandler]]
|s1=[namespace, name, arguments, returnResults] call [[BIS_fnc_callScriptedEventHandler]]

Revision as of 20:38, 13 June 2021

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