addMissionEventHandler

From Bohemia Interactive Community
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Adds event handler attached to the current mission and returns event handler handle. For the list of available mission event handlers see: Arma 3: Mission Event Handlers
Groups:
Event Handlers

Syntax

Syntax:
addMissionEventHandler [event, expression, arguments]
Parameters:
event: String - event name
expression: Code or String - expression that will be executed in missionNamespace when event handler fires.
  • If the event handler has some data to return upon activation they are stored in the _this variable
  • Arma 3 logo black.png1.64 the event handler's handle is stored in _thisEventHandler variable and is available during event handler code execution
  • Arma 3 logo black.png2.04 it is possible to pass additional arguments to the EH code via optional param. The args are stored in _thisArgs variable
Only arguments of simple types get proper serialization. Objects, Groups etc will not serialize and appear as NULLs on game load.
  • Arma 3 logo black.png2.06 the event's name is available from _thisEvent variable
since Arma 3 logo black.png2.04
arguments: Array - (Optional, default []) additional arguments to be passed to the EH code. Available during code execution via _thisArgs variable.
Return Value:
Number - the index of the currently added mission event handler is returned

Examples

Example 1:
_id = addMissionEventHandler ["PlayerDisconnected", { systemChat str _this }];
Example 2:
_id = addMissionEventHandler ["EachFrame", { systemChat str [_thisArgs, time] }, [time]];

Additional Information

See also:
removeMissionEventHandler removeAllMissionEventHandlers getEventHandlerInfo

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