BIS fnc callScriptedEventHandler: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma3 | | arma3 | ||
|1.00 | |1.00 | ||
|gr1 = Event Handlers | |gr1 = Event Handlers | ||
| 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> | | 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> | ||
| [namespace, name, arguments, returnResults] call [[BIS_fnc_callScriptedEventHandler]] | | [namespace, name, arguments, returnResults] call [[BIS_fnc_callScriptedEventHandler]] | ||
|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 | ||
|p2= name: [[String]] - handler name | |p2= name: [[String]] - handler name | ||
|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]] | ||
| [[Array]] - array with EH results or empty array | | [[Array]] - array with EH results or empty array | ||
|x1= <code><nowiki>[</nowiki>[[missionNamespace]], "event", [<nowiki/>[[player]], 123]] [[call]] [[BIS_fnc_callScriptedEventHandler]]; </code> | |x1= <code><nowiki>[</nowiki>[[missionNamespace]], "event", [<nowiki/>[[player]], 123]] [[call]] [[BIS_fnc_callScriptedEventHandler]]; </code> | ||
| [[BIS_fnc_addScriptedEventHandler]], [[BIS_fnc_removeScriptedEventHandler]], [[BIS_fnc_removeAllScriptedEventHandlers]] | | [[BIS_fnc_addScriptedEventHandler]], [[BIS_fnc_removeScriptedEventHandler]], [[BIS_fnc_removeAllScriptedEventHandlers]] | ||
}} | }} | ||
Revision as of 23:37, 17 January 2021
Description
- Description:
- Calls all the codes assigned to scripted event handler with given name. Since
1.67 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