getEventHandlerInfo

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 - not any other EH system (e.g add3DENEventHandler or addUserActionEventHandler)

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 only

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