getEventHandlerInfo: Difference between revisions

Revision as of 16:13, 7 July 2022

2.10

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 and returns 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

Groups:

Event Handlers

Syntax

Syntax:: object getEventHandlerInfo [type, id]
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
Return Value:: Array - see description

Alternative Syntax

Syntax:: object getEventHandlerInfo [type, id]
Parameters:: object: Object - entity to which event handler is assigned
: type: String - event handler name
: id: Number - event handler id returned by addMissionEventHandler or addMusicEventHandler
Return Value:: Array - see description

Examples

Example 1:: _info = player getEventHandlerInfo ["MPKilled", 1];
Example 2:: _info = getEventHandlerInfo ["EachFrame", 0];

Additional Information

See also:: addMPEventHandler addEventHandler addMissionEventHandler addMusicEventHandler

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 7: / Line 7: @@
 |gr1= Event Handlers
-|descr= Queries given event handler, whether or not it exists and is last. Also returns total number of event handlers assigned to the same event.
+|descr= Queries given event handler and returns [[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
-|s1= object [[getEventHandlerInfo]] [type, id, mpEvent]
+|s1= object [[getEventHandlerInfo]] [type, id]
 |p1= object: [[Object]] - entity to which event handler is assigned
@@ Line 15: / Line 19: @@
 |p2= type: [[String]] - event handler name
-|p3= id: [[Number]]  - event handler id returned by [[addEventHandler]] (or [[addMPEventHandler]])
+|p3= id: [[Number]]  - event handler id returned by [[addEventHandler]] or [[addMPEventHandler]]
+|r1= [[Array]] - see description
+|s2= object [[getEventHandlerInfo]] [type, id]
+|p21= object: [[Object]] - entity to which event handler is assigned
+|p22= type: [[String]] - event handler name
-|p4= mpEvent (Optional): [[Boolean]] - use [[true]] for event handlers added with [[addMPEventHandler]], default [[false]]
+|p23= id: [[Number]]  - event handler id returned by [[addMissionEventHandler]] or [[addMusicEventHandler]]
-|r1= [[Array]] - in format [exists, isLast, total] or empty array [], where:
+|r2= [[Array]] - see description
-* 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
-|x1= <sqf>_info = player getEventHandlerInfo ["MPKilled", 1, true];</sqf>
+|x1= <sqf>_info = player getEventHandlerInfo ["MPKilled", 1];</sqf>
+|x2= <sqf>_info = getEventHandlerInfo ["EachFrame", 0];</sqf>
-|seealso= [[addMPEventHandler]] [[addEventHandler]] [[addMissionEventHandler]]
+|seealso= [[addMPEventHandler]] [[addEventHandler]] [[addMissionEventHandler]] [[addMusicEventHandler]]
 }}