addMissionEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|game([0-9]) ?= (.+) \|version([0-9]) ?= (.+) " to "|game$1= $2 |version$3= $4 ")
m (Text replacement - "\] +\[" to "] [")
 
(27 intermediate revisions by 4 users not shown)
Line 8: Line 8:
|gr1= Event Handlers
|gr1= Event Handlers


|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]]
|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]]
{{Feature | informative |Since Arma 3 v1.64 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}}


|s1= '''addMissionEventHandler''' [event, expression, args]
|s1= [[addMissionEventHandler]] [event, expression, arguments]


|p1= [event, expression, args]: [[Array]]
|p1= event: [[String]] - event name


|p2= 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 {{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= expression: [[Code]] or [[String]] - expression that will be executed in [[missionNamespace]] when EH fires.
|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


|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}}
|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= <sqf>_id = addMissionEventHandler ["PlayerDisconnected", { systemChat str _this }];</sqf>


|x1= <code>_id = [[addMissionEventHandler]] ["PlayerDisconnected", { [[systemChat]] [[str]] [[Magic Variables#this|_this]] }];</code>
|x2= <sqf>_id = addMissionEventHandler ["EachFrame", { systemChat str [_thisArgs, time] }, [time]];</sqf>


|x2= <code>_id = [[addMissionEventHandler]] ["EachFrame", { [[systemChat]] [[str]] <nowiki>[</nowiki>[[_thisArgs]], [[time]]] }, <nowiki>[</nowiki>[[time]]]]; {{Since|arma3|2.03.147276|yes}}</code>
|seealso= [[removeMissionEventHandler]] [[removeAllMissionEventHandlers]] [[getEventHandlerInfo]]
 
|seealso= [[removeMissionEventHandler]], [[removeAllMissionEventHandlers]]
}}
}}

Latest revision as of 11:46, 5 May 2024

Arma 3 logo black.png0.50
LELocal
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
  • Arma 3 logo black.png1.64 the event handler's handle is stored in _thisEventHandler variable and is available during event handler code execution
  • Arma 3 logo black.png2.04 it is possible to pass additional arguments to the EH code via optional param. The args are stored in _thisArgs variable
⚠
Only arguments of simple types get proper serialization. Objects, Groups etc will not serialize and appear as NULLs on game load.
  • Arma 3 logo black.png2.06 the event's name is available from _thisEvent variable
since Arma 3 logo black.png2.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:
_id = addMissionEventHandler ["PlayerDisconnected", { systemChat str _this }];
Example 2:
_id = addMissionEventHandler ["EachFrame", { systemChat str [_thisArgs, time] }, [time]];

Additional Information

See also:
removeMissionEventHandler removeAllMissionEventHandlers getEventHandlerInfo

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
Retrieved from "https://community.bistudio.com/wiki?title=addMissionEventHandler&oldid=364158"