BIS fnc callScriptedEventHandler: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <nowiki>[</nowiki>" to " [<nowiki/>") |
mNo edit summary |
||
| Line 13: | Line 13: | ||
|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|Parameter2= | |p2= name: [[String]] - handler name|Parameter2= | ||
|p3= arguments: [[Array]] - array of arguments passed to the EH code |PARAMETER3= | |p3= arguments: [[Array]] - array of arguments passed to the EH code |PARAMETER3= | ||
|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]] |PARAMETER4= | ||
| [[Array]] - array with EH results or empty array|RETURNVALUE= | | [[Array]] - array with EH results or empty array|RETURNVALUE= | ||
| Line 23: | Line 24: | ||
|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> |EXAMPLE1= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[BIS_fnc_addScriptedEventHandler]], [[BIS_fnc_removeScriptedEventHandler]], [[BIS_fnc_removeAllScriptedEventHandlers]] |SEEALSO= | | [[BIS_fnc_addScriptedEventHandler]], [[BIS_fnc_removeScriptedEventHandler]], [[BIS_fnc_removeAllScriptedEventHandlers]] |SEEALSO= | ||
Revision as of 08:30, 25 September 2020
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:
- 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