BIS fnc callScriptedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= |p2=" to "|Parameter1= |p2=")
m (Some wiki formatting)
 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|Comments=
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |Game name=
|gr1= Event Handlers


|1.00|Game version=
|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: {{hl|_thisScriptedEventHandler}}
____________________________________________________________________________________________


| Calls all the codes assigned to scripted event handler with given name. Since {{GVI|arma3|1.67}} the code receives current EH id in the special variable: <tt>_thisScriptedEventHandler</tt>|DESCRIPTION=
|s1= [namespace, name, arguments, returnResults] call [[BIS_fnc_callScriptedEventHandler]]
____________________________________________________________________________________________


| [namespace, name, arguments, returnResults] call [[BIS_fnc_callScriptedEventHandler]] |SYNTAX=
|p1= namespace: [[Namespace]], [[Object]], [[Group]], [[Location]], [[Boolean]], [[Control]] or [[Display]] - namespace in which handler is saved


|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|=
|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]] |=


| [[Array]] - array with EH results or empty array|RETURNVALUE=
|p3= arguments: [[Array]] - array of arguments passed to the EH code
____________________________________________________________________________________________


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


|x1= <code><nowiki>[</nowiki>[[missionNamespace]], "event", <nowiki>[</nowiki>[[player]], 123]] [[call]] [[BIS_fnc_callScriptedEventHandler]]; </code> |=
|r1= [[Array]] - array with EH results or empty array
____________________________________________________________________________________________
| [[BIS_fnc_addScriptedEventHandler]], [[BIS_fnc_removeScriptedEventHandler]], [[BIS_fnc_removeAllScriptedEventHandlers]] |SEEALSO=


|x1= <sqf>[missionNamespace, "event", [player, 123]] call BIS_fnc_callScriptedEventHandler;</sqf>
|seealso= [[BIS_fnc_addScriptedEventHandler]] [[BIS_fnc_removeScriptedEventHandler]] [[BIS_fnc_removeAllScriptedEventHandlers]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Misc|{{uc:callScriptedEventHandler}}]]
[[Category:Functions|{{uc:callScriptedEventHandler}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:callScriptedEventHandler}}]]

Latest revision as of 13:24, 13 July 2022

Arma 3 logo black.png1.00
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_callScriptedEventHandler&oldid=327926"