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 ") |
Lou Montana (talk | contribs) m (Text replacement - "\] +\[" to "] [") |
||
| (24 intermediate revisions by 3 users not shown) | |||
| Line 10: | Line 10: | ||
|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]] | |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= | |s1= [[addMissionEventHandler]] [event, expression, arguments] | ||
|p1= event: [[String]] - event name | |p1= event: [[String]] - event name | ||
|p2= expression: [[Code]] or [[String]] - | |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 | * If the event handler has some data to return upon activation they are stored in the {{hl|_this}} variable | ||
* | * {{GVI|arma3|1.64|size= 0.75}} the event handler's handle is stored in {{hl|_thisEventHandler}} variable and is available during event handler code execution | ||
* | * {{GVI|arma3|2.04|size= 0.75}} it is possible to pass additional arguments to the EH code via optional param. The ''args'' are stored in {{hl|_thisArgs}} variable | ||
{{Feature|important|Only arguments of simple types get proper serialization. [[Object]]s, [[Group]]s etc will not serialize and appear as NULLs on game load.}} | |||
* {{GVI|arma3|2.06|size= 0.75}} the event's name is available from {{hl|_thisEvent}} variable | |||
|p3= | |p3= arguments: [[Array]] - (Optional, default <sqf inline>[]</sqf>) additional arguments to be passed to the EH code. Available during code execution via {{hl|_thisArgs}} variable. | ||
|p3since= arma3 2.04 | |||
|r1= [[Number]] - | |r1= [[Number]] - the index of the currently added mission event handler is returned | ||
|x1= < | |x1= <sqf>_id = addMissionEventHandler ["PlayerDisconnected", { systemChat str _this }];</sqf> | ||
|x2= < | |x2= <sqf>_id = addMissionEventHandler ["EachFrame", { systemChat str [_thisArgs, time] }, [time]];</sqf> | ||
|seealso= [[removeMissionEventHandler]] | |seealso= [[removeMissionEventHandler]] [[removeAllMissionEventHandlers]] [[getEventHandlerInfo]] | ||
}} | }} | ||
Latest revision as of 11:46, 5 May 2024
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
1.64 the event handler's handle is stored in _thisEventHandler variable and is available during event handler code execution- 2.04 it is possible to pass additional arguments to the EH code via optional param. The args are stored in _thisArgs variable
- 2.06 the event's name is available from _thisEvent variable
- since
2.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:
- Example 2:
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