BIS fnc addScriptedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= |x2=" to "|Example1= |x2=")
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 |Parameter1=


|p1= namespace: [[Namespace]], [[Object]], [[Group]], [[Location]], [[Boolean]], [[Control]] or [[Display]] - namespace in which handler is saved|Parameter1=
|p2= name: [[String]] - handler name|Parameter2=
|p2= name: [[String]] - handler name|Parameter2=


|p3= code: [[Code]] or [[String]] - code executed upon calling |=
|p3= code: [[Code]] or [[String]] - code executed upon calling |Parameter3=


| [[Number]] -  id of the currently added event handler|RETURNVALUE=
| [[Number]] -  id of the currently added event handler|RETURNVALUE=
Line 22: Line 23:




|x1= <code><nowiki>[</nowiki>[[missionNamespace]], "event", {[[hint]] "Hello World"}] [[call]] [[BIS_fnc_addScriptedEventHandler]]; </code> |Example1=
|x1= <code>[<nowiki/>[[missionNamespace]], "event", { [[hint]] "Hello World" }] [[call]] [[BIS_fnc_addScriptedEventHandler]];</code> |Example1=


|x2= <code><nowiki>[</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]] |Example2=
____________________________________________________________________________________________
____________________________________________________________________________________________
| [[BIS_fnc_callScriptedEventHandler]], [[BIS_fnc_removeScriptedEventHandler]], [[BIS_fnc_removeAllScriptedEventHandlers]] |SEEALSO=
| [[BIS_fnc_callScriptedEventHandler]], [[BIS_fnc_removeScriptedEventHandler]], [[BIS_fnc_removeAllScriptedEventHandlers]] |SEEALSO=
}}
}}



Revision as of 01:42, 22 December 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