getEventHandlerInfo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 15: Line 15:
|p2= type: [[String]] - event handler name
|p2= type: [[String]] - event handler name


|p3= id: [[Number]]  - event handler id
|p3= id: [[Number]]  - event handler id returned by [[addEventHandler]] (or [[addMPEventHandler]])


|p4= mpEvent (Optional): [[Boolean]] - use [[true]] for event handlers added with [[addMPEventHandler]], default [[false]]
|p4= mpEvent (Optional): [[Boolean]] - use [[true]] for event handlers added with [[addMPEventHandler]], default [[false]]
Line 26: Line 26:
|x1= <sqf>_info = player getEventHandlerInfo ["MPKilled", 1, true];</sqf>
|x1= <sqf>_info = player getEventHandlerInfo ["MPKilled", 1, true];</sqf>


|seealso= [[addMPEventHandler]] [[addEventHandler]]
|seealso= [[addMPEventHandler]] [[addEventHandler]] [[addMissionEventHandler]]
}}
}}

Revision as of 20:49, 6 July 2022

Hover & click on the images for description
Only available in Development branch(es) until its release with Arma 3 patch v2.10.

Description

Description:
Queries given event handler, whether or not it exists and is last. Also returns total number of event handlers assigned to the same event.
Groups:
Event Handlers

Syntax

Syntax:
object getEventHandlerInfo [type, id, mpEvent]
Parameters:
object: Object - entity to which event handler is assigned
type: String - event handler name
id: Number - event handler id returned by addEventHandler (or addMPEventHandler)
mpEvent (Optional): Boolean - use true for event handlers added with addMPEventHandler, default false
Return Value:
Array - in format [exists, isLast, total] or empty array [], where:
  • exists: Boolean - event handler exists
  • isLast: Boolean - will be executed last (relevant if last event handler modifies default engine behaviour)
  • total: Number - total number of event handlers added to the same event

Examples

Example 1:
_info = player getEventHandlerInfo ["MPKilled", 1, true];

Additional Information

See also:
addMPEventHandler addEventHandler addMissionEventHandler

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