BIS fnc addScriptedEventHandler: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Misc(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Function|Comments= | {{Function|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 7: | Line 6: | ||
|gr1= Event Handlers |GROUP1= | |gr1= Event Handlers |GROUP1= | ||
| Adds scripted event handler and returns its id. Additionally "ScriptedEventHandlerAdded" scripted EH is called. For the list of available scripted event handlers see [[Arma 3: Event Handlers/ScriptedEventHandlers]]. |DESCRIPTION= | | Adds scripted event handler and returns its id. Additionally "ScriptedEventHandlerAdded" scripted EH is called. For the list of available scripted event handlers see [[Arma 3: Event Handlers/ScriptedEventHandlers]]. |DESCRIPTION= | ||
| [namespace, name, code] call [[BIS_fnc_addScriptedEventHandler]] |SYNTAX= | | [namespace, name, code] call [[BIS_fnc_addScriptedEventHandler]] |SYNTAX= | ||
| Line 21: | Line 18: | ||
| [[Number]] - id of the currently added event handler|RETURNVALUE= | | [[Number]] - id of the currently added event handler|RETURNVALUE= | ||
| Line 28: | Line 24: | ||
|x2= <code>[<nowiki/>[[true]], "event", { [[hint]] "Hello World" }] [[call]] [[BIS_fnc_addScriptedEventHandler]];</code> | |x2= <code>[<nowiki/>[[true]], "event", { [[hint]] "Hello World" }] [[call]] [[BIS_fnc_addScriptedEventHandler]];</code> | ||
Boolean will default to [[missionNamespace]] |Example2= | Boolean will default to [[missionNamespace]] |Example2= | ||
| [[BIS_fnc_callScriptedEventHandler]], [[BIS_fnc_removeScriptedEventHandler]], [[BIS_fnc_removeAllScriptedEventHandlers]] |SEEALSO= | | [[BIS_fnc_callScriptedEventHandler]], [[BIS_fnc_removeScriptedEventHandler]], [[BIS_fnc_removeAllScriptedEventHandlers]] |SEEALSO= | ||
}} | }} | ||
Revision as of 23:36, 16 January 2021
Description
- Description:
- Adds scripted event handler and returns its id. Additionally "ScriptedEventHandlerAdded" scripted EH is called. For the list of available scripted event handlers see Arma 3: Event Handlers/ScriptedEventHandlers.
- Execution:
- call
- Groups:
- Event Handlers
Syntax
- Syntax:
- [namespace, name, code] call BIS_fnc_addScriptedEventHandler
- Parameters:
- namespace: Namespace, Object, Group, Location, Boolean, Control or Display - namespace in which handler is saved
- name: String - handler name
- code: Code or String - code executed upon calling
- Return Value:
- Number - id of the currently added event handler
Examples
- Example 1:
[missionNamespace, "event", { hint "Hello World" }] call BIS_fnc_addScriptedEventHandler;- Example 2:
[true, "event", { hint "Hello World" }] call BIS_fnc_addScriptedEventHandler;Boolean will default to missionNamespace
Additional Information
- See also:
- BIS_fnc_callScriptedEventHandlerBIS_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