addMissionEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "(\| * )+\}\}" to "}}")
m (Text replacement - " {3,}\|" to " |")
Line 20: Line 20:


| [[Number]] - The index of the currently added mission event handler is returned.
| [[Number]] - The index of the currently added mission event handler is returned.


|x1= <code>// A script could be executed to stop custom scripts graciously, or save progress & stats, for example:
|x1= <code>// A script could be executed to stop custom scripts graciously, or save progress & stats, for example:


_id = [[addMissionEventHandler]] ["Ended",{ _this [[execVM]] "missionEnded.sqf" }];</code>
_id = [[addMissionEventHandler]] ["Ended",{ _this [[execVM]] "missionEnded.sqf" }];</code>


| [[removeMissionEventHandler]], [[removeAllMissionEventHandlers]]
| [[removeMissionEventHandler]], [[removeAllMissionEventHandlers]]


}}
}}

Revision as of 18:02, 18 January 2021

Hover & click on the images for description

Description

Description:
Adds event handler (EH) attached to the current mission and returns EH handle. If EH has some data to return upon event, it is passed in _this variable. Since Arma 3 v.1.63.137807 the EH handle is also stored in _thisEventHandler variable and is available during EH code execution.

For the list of available mission event handlers see: Arma_3:_Event_Handlers/addMissionEventHandler
Groups:
Event Handlers

Syntax

Syntax:
addMissionEventHandler [type, command]
Parameters:
[type, command]: Array
type: String
command: Code or String - By default executed in missionNamespace
Return Value:
Number - The index of the currently added mission event handler is returned.

Examples

Example 1:
// A script could be executed to stop custom scripts graciously, or save progress & stats, for example: _id = addMissionEventHandler ["Ended",{ _this execVM "missionEnded.sqf" }];

Additional Information

See also:
removeMissionEventHandlerremoveAllMissionEventHandlers

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