addMPEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (semicolon removed as it is not documented in any other command page)
(_thisEventHandler)
Line 11: Line 11:
____________________________________________________________________________________________
____________________________________________________________________________________________


| The format of handler is [type,command]. Check scripting topic Event handlers for more information. The index of the current handler is returned. |= Description
| Adds MP event handler (EH) to the given object and returns EH handle. MP event handlers are added globally to every client on network in multiplayer and will fire on every client too upon event. 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 <tt>_this</tt> variable. Since Arma 3 v.1.63.137807 the EH handle is also stored in <tt>_thisEventHandler</tt> variable and is available during EH code execution.<br><br> For more information see: [[Arma_3:_Event_Handlers#addMPEventHandler]] |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| unitName '''addMPEventHandler''' [type, command]  |= Syntax
| object '''addMPEventHandler''' [type, expression]  |= Syntax


|p1= unitName: [[Object]] - object to monitor |=  
|p1= object: [[Object]] - object to monitor |=  
|p2= type: [[String]] - event handler name |=
|p2= [type, expression] - [[Array]] |=
|p3= command: [[String]] or [[Code]] - code to execute|=
|p3= type: [[String]] - event handler name |=
|p4= expression: [[String]] or [[Code]] - expression to execute|=


| [[Number]] |= Return value
| [[Number]] |= Return value

Revision as of 10:47, 1 August 2016

Hover & click on the images for description

Description

Description:
Adds MP event handler (EH) to the given object and returns EH handle. MP event handlers are added globally to every client on network in multiplayer and will fire on every client too upon event. 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.63.137807 the EH handle is also stored in _thisEventHandler variable and is available during EH code execution.

For more information see: Arma_3:_Event_Handlers#addMPEventHandler
Groups:
Uncategorised

Syntax

Syntax:
object addMPEventHandler [type, expression]
Parameters:
object: Object - object to monitor
[type, expression] - Array
type: String - event handler name
expression: String or Code - expression to execute
Return Value:
Number

Examples

Example 1:
_index = player addMPEventHandler ["mpkilled", {Null = _this execVM "playerkilled.sqf";}];

Additional Information

See also:
EventHandlers listremoveMPEventHandlerremoveAllMPEventHandlers

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

Notes

Bottom Section

Posted on May 8, 2015 - 12:24 (UTC)
Killzone Kid
MP EHs are added on every PC and execute on every PC, apart from MPRespawn, that only executes at the locality where unit respawns.