addMissionEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "\| *p([0-9]) *=([^ ]+) *\{\{Since\|(.+)\|([0-9]\.[0-9][02468])[^ ]+\}\} " to "|p$1= $2 |p$1since= $3 $4 ")
Line 20: Line 20:
* Since Arma 3 v2.06 the name of the event is available from <tt>_thisEvent</tt> variable
* Since Arma 3 v2.06 the name of the event is available from <tt>_thisEvent</tt> variable


|p3= args (Optional, default {{ic|[]}}): [[Array]] - Additional arguments to be passed to the EH code. Available during code execution via <tt>_thisArgs</tt> variable. {{Since|arma3|2.04|yes}}
|p3= args (Optional, default {{ic|[]}}): [[Array]] - Additional arguments to be passed to the EH code. Available during code execution via <tt>_thisArgs</tt> variable.
|p3since= arma3 2.04


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

Revision as of 23:39, 10 August 2021

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
  • Since Arma 3 v1.64 the event handler handle is also stored in _thisEventHandler variable and is available during event handler code execution
  • Since Arma 3 v2.04 it is possible to pass additional arguments to the EH code via optional param. The args are stored in _thisArgs variable
  • Since Arma 3 v2.06 the name of the event is available from _thisEvent variable
since Arma 3 logo black.png2.04
args (Optional, default []): Array - 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]]; 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