getEventHandlerInfo: Difference between revisions

Latest revision as of 14:23, 23 August 2022

2.10

Hover & click on the images for description

Description

Description:: Queries given event handler's information.
Groups:: Event Handlers

Syntax

Syntax:

oper getEventHandlerInfo [type, id]

Parameters:

oper: Object, Group, Control or Display - subject to which event handler is assigned

type: String - event handler name

id: Number - event handler id returned by addEventHandler, ctrlAddEventHandler, displayAddEventHandler, or addMPEventHandler

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

Alternative Syntax

Syntax:

getEventHandlerInfo [type, id]

Parameters:

type: String - event handler name

id: Number - event handler id returned by addMissionEventHandler or addMusicEventHandler

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:: private _info = player getEventHandlerInfo ["MPKilled", 1]; // object EH
Example 2:: private _info = getEventHandlerInfo ["EachFrame", 0]; // mission EH
Example 3:: private _info = _bullet getEventHandlerInfo ["Deflected", 0]; // projectile EH
Example 4:: private _info = _group getEventHandlerInfo ["EnemyDetected", 1]; // group EH
Example 5:: private _info = _control getEventHandlerInfo ["ButtonClick", 1]; // control (UI) EH

Additional Information

See also:: addEventHandler ctrlAddEventHandler displayAddEventHandler addMPEventHandler 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 3: / Line 3: @@
 |game1= arma3
 |version1= 2.10
-|branch= dev
 |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's information.
-|s1= object [[getEventHandlerInfo]] [type, id, mpEvent]
+|s1= oper [[getEventHandlerInfo]] [type, id]
-|p1= object: [[Object]] - entity to which EH is assigned
+|p1= oper: [[Object]], [[Group]], [[Control]] or [[Display]] - subject to which event handler is assigned
 |p2= type: [[String]] - event handler name
-|p3= id: [[Number]]  - event handler id
+|p3= id: [[Number]] - event handler id returned by [[addEventHandler]], [[ctrlAddEventHandler]], [[displayAddEventHandler]], or [[addMPEventHandler]]
-|p4= mpEvent (Optional): [[Boolean]] - use [[true]] for event handlers added with [[addMPEventHandler]], default [[false]]
+|r1= [[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
+|s2= [[getEventHandlerInfo]] [type, id]
+|p21= type: [[String]] - event handler name
+|p22= id: [[Number]] - event handler id returned by [[addMissionEventHandler]] or [[addMusicEventHandler]]
-|r1= [[Array]] - in format [exists, isLast, total], where:
+|r2= [[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
-|x1= <sqf>_info = player getEventHandlerInfo ["MPKilled", 1, true];</sqf>
+|x1= <sqf>private _info = player getEventHandlerInfo ["MPKilled", 1];		// object EH</sqf>
+|x2= <sqf>private _info = getEventHandlerInfo ["EachFrame", 0];				// mission EH</sqf>
+|x3= <sqf>private _info = _bullet getEventHandlerInfo ["Deflected", 0];		// projectile EH</sqf>
+|x4= <sqf>private _info = _group getEventHandlerInfo ["EnemyDetected", 1];	// group EH</sqf>
+|x5= <sqf>private _info = _control getEventHandlerInfo ["ButtonClick", 1];	// control (UI) EH</sqf>
-|seealso= [[addMissionEventHandler]] [[addEventHandler]]
+|seealso= [[addEventHandler]] [[ctrlAddEventHandler]] [[displayAddEventHandler]] [[addMPEventHandler]] [[addMissionEventHandler]] [[addMusicEventHandler]]
 }}