getEventHandlerInfo

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's information.

Groups:

Event Handlers

Syntax

Syntax:

entity getEventHandlerInfo [type, id]

Parameters:

entity: Object, Group, Control or Display - entity 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:

_info = player getEventHandlerInfo ["MPKilled", 1]; // object EH

Example 2:

_info = getEventHandlerInfo ["EachFrame", 0]; // mission EH

Example 3:

_info = _bullet getEventHandlerInfo ["Deflected", 0]; // projectile EH

Example 4:

_info = _group getEventHandlerInfo ["EnemyDetected", 1]; // group EH

Example 5:

_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