addMissionEventHandler: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\| *((\[\[.*\]\],? ?)+) * \}\}" to "|seealso= $1 }}") |
m (some formatting) |
||
| Line 1: | Line 1: | ||
{{RV|type=command | {{RV|type=command | ||
| arma3 | |game1= arma3 | ||
|0.50 | |version1= 0.50 | ||
|eff= local | |eff= local | ||
| Line 9: | Line 9: | ||
|gr1= Event Handlers | |gr1= Event Handlers | ||
| 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. For the list of available mission event handlers see: [[ | |descr= 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. For the list of available mission event handlers see: [[Arma 3: Event Handlers/addMissionEventHandler]] | ||
{{Feature | informative |Since Arma 3 v1.63.137807 the EH handle is also stored in <tt>_thisEventHandler</tt> variable and is available during EH code execution.<br> | {{Feature | informative |Since Arma 3 v1.63.137807 the EH handle is also stored in <tt>_thisEventHandler</tt> variable and is available during EH code execution.<br> | ||
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 <tt>_thisArgs</tt> variable}} | 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 <tt>_thisArgs</tt> variable}} | ||
| '''addMissionEventHandler''' [event, expression, args] | |s1= '''addMissionEventHandler''' [event, expression, args] | ||
|p1= [event, expression, args]: [[Array]] | |p1= [event, expression, args]: [[Array]] | ||
| Line 21: | Line 21: | ||
|p3= expression: [[Code]] or [[String]] - expression that will be executed in [[missionNamespace]] when EH fires. | |p3= expression: [[Code]] or [[String]] - expression that will be executed in [[missionNamespace]] when EH fires. | ||
|p4= args (Optional): [[Array]] - | |p4= args (Optional): [[Array]] - additional arguments to be passed to the EH code. Available during code execution via <tt>_thisArgs</tt> variable. {{Since|arma3|2.03.147276|yes}} | ||
| [[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]] [[_this]] }];</code> | |x1= <code>_id = [[addMissionEventHandler]] ["PlayerDisconnected", { [[systemChat]] [[str]] [[_this]] }];</code> | ||
|x2= | |x2= <code>_id = [[addMissionEventHandler]] ["EachFrame", { [[systemChat]] [[str]] <nowiki>[</nowiki>[[_thisArgs]], [[time]]] }, <nowiki>[</nowiki>[[time]]]]; {{Since|arma3|2.03.147276|yes}}</code> | ||
|seealso= [[removeMissionEventHandler]], [[removeAllMissionEventHandlers]] | |seealso= [[removeMissionEventHandler]], [[removeAllMissionEventHandlers]] | ||
}} | }} | ||
Revision as of 12:44, 24 February 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. For the list of available mission event handlers see: Arma 3: Event Handlers/addMissionEventHandler
- 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
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