addMissionEventHandler

0.50

LELocal

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. For the list of available mission event handlers see: Arma 3: Event Handlers/addMissionEventHandler

ⓘ

Since Arma 3 v1.64 the EH handle is also stored in _thisEventHandler variable and is available during EH code execution.
Since Arma 3 v2.03.147276 it is possible to pass additional arguments to the EH code via optional param. The arguments are stored in _thisArgs variable

Groups:

Event Handlers

Syntax

Syntax:

addMissionEventHandler [event, expression, args]

Parameters:

[event, expression, args]: Array

event: String - event name

expression: Code or String - expression that will be executed in missionNamespace when EH fires.

args (Optional): Array - additional arguments to be passed to the EH code. Available during code execution via _thisArgs variable. Template:Since

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]]; Template:Since

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