BIS fnc callScriptedEventHandler: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "\[\[[cC]ategory:\{\{Name\|arma3\}\}: [fF]unctions\|\{\{uc:[a-z A-Z_]*\}\}\]\]" to "") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{RV|type=function | {{RV|type=function | ||
| arma3 | |game1= arma3 | ||
|version1= 1.00 | |||
| | |gr1= Event Handlers | ||
| | |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}} | ||
| | |s1= [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 | ||
| Line 17: | Line 16: | ||
|p3= arguments: [[Array]] - array of arguments passed to the EH code | |p3= arguments: [[Array]] - array of arguments passed to the EH code | ||
|p4= returnResults | |p4= returnResults: [[Boolean]] - (Optional, default [[false]]) if [[true]] EH will place results from each code execution into an array using EH id as index | ||
|r1= [[Array]] - array with EH results or empty array | |||
| [[ | |x1= <sqf>[missionNamespace, "event", [player, 123]] call BIS_fnc_callScriptedEventHandler;</sqf> | ||
| | |seealso= [[BIS_fnc_addScriptedEventHandler]] [[BIS_fnc_removeScriptedEventHandler]] [[BIS_fnc_removeAllScriptedEventHandlers]] | ||
}} | }} | ||
Latest revision as of 13:24, 13 July 2022
Description
- Description:
- Calls all the codes assigned to scripted event handler with given name. Since
1.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:
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