BIS fnc addScriptedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(syntax, parameters, and examples, see also)
(format)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Adds scripted event handler and returns id. "ScriptedEventHandlerAdded" scripted EH is called. |= Description
 
Description:
Add scripted event handler
 
Parameter(s):
0: NAMESPACE, OBJECT, GROUP or LOCATION - namespace in which handler is saved
1: STRING - handler name
2: CODE or STRING - code executed upon calling
 
Returns:
NUMBER - handler ID
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


|  [missionNamespace,"",""] call [[BIS_fnc_addScriptedEventHandler]]; |= Syntax
|  [namespace, name, code] call [[BIS_fnc_addScriptedEventHandler]]; |= Syntax
 
|p1=<b>NAMESPACE, OBJECT, GROUP LOCATION or BOOLEAN</b> - namespace in which handler is saved|
p2= <b>STRING</b> - handler name|
p3=<b>CODE or STRING </b>- code executed upon calling |= Parameter 1
 
 
object: Object
[type, command]: Array
type: String - Event Handler type
command: Code or String - code that should be executed once the event occurs, by default executed in missionNamespace
 


|p1= namespace: [[Namespace]], [[Object]], [[Group]], [[Location]], [[Boolean]], [[Control]] or [[Display]] - namespace in which handler is saved|=
|p2= name: [[String]] - handler name|=
|p3= code: [[Code]] or [[String]] - code executed upon calling |=


| Number - The index of the currently added event handler is returned. Indices start at 0 for each unit and increment with each added event handler.|= Return value
| [[Number]] - id of the currently added event handler|= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
Examples:
|x1= <code> [missionNamespace,"event",{hint "Hello World";}] call bis_fnc_addScriptedEventhandler; </code> |=


|x2= stacking code:<code>[missionNamespace,"event",{STRING "Hello World";}] call BIS_fnc_addScriptedEventhandler;
[missionNamespace,"event",{hint STRING;}] call BIS_fnc_addScriptedEventhandler;


[missionNamespace,"event",[]] call BIS_fnc_callScriptedEventHandler;  
|x1= <code><nowiki>[</nowiki>[[missionNamespace]], "event", {[[hint]] "Hello World"}] [[call]] [[BIS_fnc_addScriptedEventHandler]]; </code> |=  
</code> will show "Hello World" on screen. |=  


|x3= <code> [true,"event",{hint "Hello World";}] call bis_fnc_addScriptedEventhandler; </code>  
|x2= <code><nowiki>[</nowiki>[[true]], "event", {[[hint]] "Hello World"}] [[call]] [[BIS_fnc_addScriptedEventHandler]]; </code>  
Boolean will default to misionNameSpace |=  
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]] |= See also


}}
}}

Revision as of 19:02, 12 December 2016


Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Adds scripted event handler and returns id. "ScriptedEventHandlerAdded" scripted EH is called.
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

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_addScriptedEventHandler&oldid=98153"