BIS fnc addScriptedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3>" to "")
m (Text replacement - " {3,}\|" to " |")
Line 18: Line 18:


| [[Number]] -  id of the currently added event handler
| [[Number]] -  id of the currently added 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>

Revision as of 23:42, 18 January 2021

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