addMissionEventHandler: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\|game([0-9]) ?= (.+) \|version([0-9]) ?= (.+) " to "|game$1= $2 |version$3= $4 ") |
m (formatting) |
||
| Line 2: | Line 2: | ||
|game1= arma3 | |game1= arma3 | ||
|version1= 0.50 | |version1= 0.50 | ||
| Line 8: | Line 9: | ||
|gr1= Event Handlers | |gr1= Event Handlers | ||
|descr= Adds event handler | |descr= 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]] | ||
| | |s1= '''addMissionEventHandler''' [event, expression, arguments] | ||
| | |p1= event: [[String]] - event name | ||
| | |p2= 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 <tt>_this</tt> variable | |||
* Since Arma 3 v1.64 the event handler handle is also stored in <tt>_thisEventHandler</tt> 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 <tt>_thisArgs</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}} | ||
|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 | ||
|x1= <code>_id = [[addMissionEventHandler]] ["PlayerDisconnected", { [[systemChat]] [[str]] [[Magic Variables#this|_this]] }];</code> | |x1= <code>_id = [[addMissionEventHandler]] ["PlayerDisconnected", { [[systemChat]] [[str]] [[Magic Variables#this|_this]] }];</code> | ||
|x2= <code>_id = [[addMissionEventHandler]] ["EachFrame", { [[systemChat]] [[str]] <nowiki>[</nowiki>[[_thisArgs]], [[time]]] }, <nowiki>[</nowiki>[[time]]]]; {{Since|arma3|2. | |x2= <code>_id = [[addMissionEventHandler]] ["EachFrame", { [[systemChat]] [[str]] <nowiki>[</nowiki>[[_thisArgs]], [[time]]] }, <nowiki>[</nowiki>[[time]]]]; {{Since|arma3|2.04|yes}}</code> | ||
|seealso= [[removeMissionEventHandler]], [[removeAllMissionEventHandlers]] | |seealso= [[removeMissionEventHandler]], [[removeAllMissionEventHandlers]] | ||
}} | }} | ||
Revision as of 19:10, 7 May 2021
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
- args (Optional, default
[]): 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
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