addMissionEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Bot: Reverted to revision 96955 by killzone_kid on 2016-08-01T08:35:51Z)
m (template:command argument fix)
Line 12: Line 12:
| '''addMissionEventHandler''' [type, command] |= Syntax
| '''addMissionEventHandler''' [type, command] |= Syntax


|p1= [type, command]: [[Array]]  |= PARAMETER1
|p1= [type, command]: [[Array]]  |PARAMETER1=  


|p2= type: [[String]]  |= PARAMETER2
|p2= type: [[String]]  |PARAMETER2=


|p3= command: [[Code]] or [[String]] - By default executed in [[missionNamespace]] |= PARAMETER3
|p3= command: [[Code]] or [[String]] - By default executed in [[missionNamespace]] |PARAMETER3=


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




|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>|= EXAMPLE1
_id = [[addMissionEventHandler]] ["Ended",{ _this [[execVM]] "missionEnded.sqf" }];</code>|EXAMPLE1=  


____________________________________________________________________________________________
____________________________________________________________________________________________


| [[removeMissionEventHandler]], [[removeAllMissionEventHandlers]] |= SEEALSO
| [[removeMissionEventHandler]], [[removeAllMissionEventHandlers]] |SEEALSO=  


|  |= MPBEHAVIOUR
|  |MPBEHAVIOUR=  
____________________________________________________________________________________________
____________________________________________________________________________________________
}}
}}

Revision as of 11:28, 7 April 2019

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

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

Notes

Bottom Section