BIS fnc addScriptedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(see also)
m (template:command argument fix)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| 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=


|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 17:
|p3= code: [[Code]] or [[String]] - code executed upon calling |=
|p3= code: [[Code]] or [[String]] - code executed upon calling |=


| [[Number]] -  id of the currently added event handler|= Return value
| [[Number]] -  id of the currently added event handler|RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 26: Line 26:
Boolean will default to [[missionNamespace]] |=  
Boolean will default to [[missionNamespace]] |=  
____________________________________________________________________________________________
____________________________________________________________________________________________
| [[BIS_fnc_callScriptedEventHandler]], [[BIS_fnc_removeScriptedEventHandler]], [[BIS_fnc_removeAllScriptedEventHandlers]] |= See also
| [[BIS_fnc_callScriptedEventHandler]], [[BIS_fnc_removeScriptedEventHandler]], [[BIS_fnc_removeAllScriptedEventHandlers]] |SEEALSO=


}}
}}

Revision as of 12:26, 7 April 2019


Hover & click on the images for description

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:
Uncategorised

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

Notes

Bottom Section