BIS fnc callScriptedEventHandler: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Killzone Kid (talk | contribs) (format) |
||
| Line 8: | Line 8: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| < | | Calls all the codes assigned to scripted event handler with given name. Since Arma 3 v1.67 the code receives current EH id in the special variable: <tt>_thisScriptedEventHandler</tt>|= Description | ||
____________________________________________________________________________________________ | |||
| [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|= | |||
|p2= name: [[String]] - handler name|= | |||
|p3= arguments: [[Array]] - array of arguments passed to he 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|= Return value | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | |x1= <code><nowiki>[</nowiki>[[missionNamespace]], "event", <nowiki>[</nowiki>[[player]], 123]] [[call]] [[BIS_fnc_callScriptedEventHandler]]; </code> |= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[BIS_fnc_addScriptedEventHandler]], [[BIS_fnc_removeScriptedEventHandler]], [[BIS_fnc_removeAllScriptedEventHandlers]] |= See also | |||
| [[BIS_fnc_addScriptedEventHandler]] |= See also | |||
}} | }} | ||
| Line 50: | Line 39: | ||
[[Category:Functions|{{uc:callScriptedEventHandler}}]] | [[Category:Functions|{{uc:callScriptedEventHandler}}]] | ||
[[Category:{{Name|arma3}}: Functions|{{uc:callScriptedEventHandler}}]] | [[Category:{{Name|arma3}}: Functions|{{uc:callScriptedEventHandler}}]] | ||
Revision as of 20:41, 12 December 2016
Description
- Description:
- Calls all the codes assigned to scripted event handler with given name. Since Arma 3 v1.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 he 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