addMissionEventHandler: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Add eL) |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 9: | Line 8: | ||
|gr1= Event Handlers |GROUP1= | |gr1= Event Handlers |GROUP1= | ||
| 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 <tt>_this</tt> variable. Since Arma 3 v.1.63.137807 the EH handle is also stored in <tt>_thisEventHandler</tt> variable and is available during EH code execution.<br><br>For the list of available mission event handlers see: [[Arma_3:_Event_Handlers/addMissionEventHandler]]|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 <tt>_this</tt> variable. Since Arma 3 v.1.63.137807 the EH handle is also stored in <tt>_thisEventHandler</tt> variable and is available during EH code execution.<br><br>For the list of available mission event handlers see: [[Arma_3:_Event_Handlers/addMissionEventHandler]]|DESCRIPTION= | ||
| '''addMissionEventHandler''' [type, command] |SYNTAX= | | '''addMissionEventHandler''' [type, command] |SYNTAX= | ||
| Line 29: | Line 26: | ||
_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 00:00, 17 January 2021
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
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