BIS fnc addScriptedEventHandler: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "= <code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-_]+)\]\]([^<]*)<\/code>" to "= <code>$1$2$3</code>") |
Lou Montana (talk | contribs) m (Text replacement - "= <code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-_]+)\]\]([^<]*)<\/code>" to "= <code>$1$2$3</code>") |
||
| Line 18: | Line 18: | ||
|r1= [[Number]] - The ID of the new Event Handler | |r1= [[Number]] - The ID of the new Event Handler | ||
|x1= <code>[missionNamespace, "event", { hint "Hello World" }] | |x1= <code>[missionNamespace, "event", { hint "Hello World" }] call [[BIS_fnc_addScriptedEventHandler]];</code> | ||
|x2= <code>[true, "event", { hint "Hello World" }] | |x2= <code>[true, "event", { hint "Hello World" }] call [[BIS_fnc_addScriptedEventHandler]];</code> | ||
Boolean will default to [[missionNamespace]]. | Boolean will default to [[missionNamespace]]. | ||
|seealso= [[BIS_fnc_callScriptedEventHandler]] [[BIS_fnc_removeScriptedEventHandler]] [[BIS_fnc_removeAllScriptedEventHandlers]] | |seealso= [[BIS_fnc_callScriptedEventHandler]] [[BIS_fnc_removeScriptedEventHandler]] [[BIS_fnc_removeAllScriptedEventHandlers]] | ||
}} | }} | ||
Revision as of 17:56, 13 July 2022
Description
- Description:
- Adds a Scripted Event Handler and returns its ID. Additionally, the "ScriptedEventHandlerAdded" Scripted EH is called. For the full list of all available Scripted EHs see Arma 3: Scripted Event Handlers.
- 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 the EH is stored
- name: String - Event name
- code: Code or String - The code that is executed when the EH fires. The magic variable _thisScriptedEventHandler can be used to access the event handler ID within the code.
- Return Value:
- Number - The ID of the new 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_callScriptedEventHandler 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