BIS fnc callScriptedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Some wiki formatting)
 
(38 intermediate revisions by 4 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}}
____________________________________________________________________________________________


| <pre>/*
|s1= [namespace, name, arguments, returnResults] call [[BIS_fnc_callScriptedEventHandler]]


Description:
|p1= namespace: [[Namespace]], [[Object]], [[Group]], [[Location]], [[Boolean]], [[Control]] or [[Display]] - namespace in which handler is saved
Call scripted event handlers


Parameter(s):
|p2= name: [[String]] - handler name
0: NAMESPACE, OBJECT, GROUP or LOCATION - namespace in which handler is saved
1: STRING - handler name
2: ARRAY - arguments passed to the code
3 (Optional): BOOL - true to expect returned value from all codes


Returns:
|p3= arguments: [[Array]] - array of arguments passed to the EH code
ARRAY - list of returned values
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


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


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


| |= Return value
|x1= <sqf>[missionNamespace, "event", [player, 123]] call BIS_fnc_callScriptedEventHandler;</sqf>
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| [[BIS_fnc_addScriptedEventHandler]] |= See also


|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}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on May 15, 2016 - 19:29 (UTC)</dd>
<dt class="note">[[User:RageBone|RageBone]]</dt>
<dd class="note">
Example:<br>
<code>
[missionNamespace,"event",[]] call bis_fnc_callScriptedEventHandler;
</code><br>
Interestingly, the return value is always an empty array.<br>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

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"