BIS fnc addScriptedEventHandler: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ :\\\-\/|()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}") |
(Improvements here and there) |
||
| Line 1: | Line 1: | ||
{{RV|type=function | {{RV|type=function | ||
| arma3 | |game1= arma3 | ||
|1.00 | |version1= 1.00 | ||
|gr1= Event Handlers | |gr1= Event Handlers | ||
| Adds | |descr= 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]]. | ||
| [namespace, name, code] call [[BIS_fnc_addScriptedEventHandler]] | |s1= [namespace, name, code] call [[BIS_fnc_addScriptedEventHandler]] | ||
|p1= namespace: [[Namespace]], [[Object]], [[Group]], [[Location]], [[Boolean]], [[Control]] or [[Display]] - | |p1= namespace: [[Namespace]], [[Object]], [[Group]], [[Location]], [[Boolean]], [[Control]] or [[Display]] - Namespace in which the EH is stored | ||
|p2= name: [[String]] - | |p2= name: [[String]] - Event name | ||
|p3= code: [[Code]] or [[String]] - code executed | |p3= code: [[Code]] or [[String]] - The code that is executed when the EH fires | ||
| [[Number]] - | |r1= [[Number]] - The ID of the new Event Handler | ||
|x1= <code>[<nowiki/>[[missionNamespace]], "event", { [[hint]] "Hello World" }] [[call]] [[BIS_fnc_addScriptedEventHandler]];</code> | |x1= <code>[<nowiki/>[[missionNamespace]], "event", { [[hint]] "Hello World" }] [[call]] [[BIS_fnc_addScriptedEventHandler]];</code> | ||
|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]] | Boolean will default to [[missionNamespace]]. | ||
|seealso= [[BIS_fnc_callScriptedEventHandler]] | |||
|seealso= [[BIS_fnc_callScriptedEventHandler]] [[BIS_fnc_removeScriptedEventHandler]] [[BIS_fnc_removeAllScriptedEventHandlers]] | |||
}} | }} | ||
Revision as of 11:26, 31 March 2021
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
- 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