addMPEventHandler: Difference between revisions

Latest revision as of 14:52, 16 October 2024

1.55

1.00

0.50

GAGlobal GEGlobal

Hover & click on the images for description

Description

Description:: Adds a multiplayer event handler (EH) to the given object and returns EH handle. See Event Handlers.
⚠
A Multiplayer Event Handler is not saved in a save file and therefore will not be restored on load - use it accordingly.
Multiplayer:: Multiplayer EHs are added globally to every client and the server will fire on itself and every client upon event. The only exception is the MPRespawn EH that one only fires where the respawned unit is local. Make sure to check the EHs' locality in Event Handlers pages.
Groups:: Multiplayer Event Handlers

Syntax

Syntax:

object addMPEventHandler [type, expression]

Parameters:

object: Object - object to monitor

type: String - event handler name

expression: String or Code - expression to execute.
If EH has some data to return upon event (e.g. the "MPKilled" EH will return an array with 2 elements: the killed unit, and the killer), it is passed in _this variable.

Since Arma 3 v.1.64 the EH handle is also stored in _thisEventHandler variable and is available during EH code execution.

Event Handler parameters are accessible via _this
The Event Handler type is available as _thisEvent
The Event Handler index is available as _thisEventHandler

Return Value:

Number - event handler index

Examples

Example 1:: _index = player addMPEventHandler ["MPKilled", { _this execVM "playerKilled.sqf"; }];

Additional Information

See also:: EventHandlers List removeMPEventHandler removeAllMPEventHandlers 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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma2oa |= Game name
+|game1= arma2oa
+|version1= 1.55
-|1.55|= Game version
+|game2= tkoh
-____________________________________________________________________________________________
+|version2= 1.00
-| The format of handler is [type,command]. Check scripting topic Event handlers for more information. The index of the current handler is returned. |= Description
+|game3= arma3
-____________________________________________________________________________________________
+|version3= 0.50
-| unitName '''addMPEventHandler''' ["event", {action}];  |= Syntax
+|gr1= Multiplayer
-|p1= unitName: [[Object]] |=
+|gr2= Event Handlers
-|p2= event: [[String]]|=
-|p3= action: [[Code]]|=
-| [[Number]] or [[Nothing]] |= Return value
+|arg= global
-____________________________________________________________________________________________
-|x1= <code> _index <nowiki>=</nowiki> player '''addMPEventHandler''' ["mpkilled", {Null <nowiki>=</nowiki> _this execVM "playerkilled.sqf";}]; </code> |=
+|eff= global
-____________________________________________________________________________________________
-| [[:Category:Event Handlers|EventHandlers list]], [[removeMPEventHandler]], [[removeAllMPEventHandlers]] |= See also
+|descr= Adds a multiplayer event handler (EH) to the given object and returns EH handle. See {{Link|Category:Event Handlers|Event Handlers}}.
-}}
+{{Feature|important|A Multiplayer Event Handler is '''not''' saved in a save file and therefore will not be restored on load - use it accordingly.}}
+|mp= Multiplayer EHs are added globally to every client and the server will fire on itself and every client upon event.
+The only exception is the '''MPRespawn''' EH that one only fires where the respawned unit is local. Make sure to check the EHs' locality in {{Link|Category:Event Handlers|Event Handlers}} pages.
+|s1= object [[addMPEventHandler]] [type, expression]
+|p1= object: [[Object]] - object to monitor
+|p2= type: [[String]] - event handler name
-<h3 style="display:none">Notes</h3>
+|p3= expression: [[String]] or [[Code]] - expression to execute.<br>
-<dl class="command_description">
+If EH has some data to return upon event (e.g. the "MPKilled" EH will return an array with 2 elements: the killed unit, and the killer), it is passed in {{hl|_this}} variable.
-<!-- Note Section BEGIN -->
+{{Feature|arma3|Since Arma 3 v.1.64 the EH handle is also stored in {{hl|_thisEventHandler}} variable and is available during EH code execution.}}
+* Event Handler parameters are accessible via <sqf inline>_this</sqf>
+* The Event Handler type is available as <sqf inline>_thisEvent</sqf>
+* The Event Handler index is available as <sqf inline>_thisEventHandler</sqf>
-<!-- Note Section END -->
+|r1= [[Number]] - event handler index
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|x1= <sqf>_index = player addMPEventHandler ["MPKilled", { _this execVM "playerKilled.sqf"; }];</sqf>
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
+|seealso= [[:Category:Event Handlers|EventHandlers List]] [[removeMPEventHandler]] [[removeAllMPEventHandlers]] [[getEventHandlerInfo]]
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
+}}
-[[Category:ArmA 2 OA: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]