ctrlAddEventHandler

1.001.501.000.50

Hover & click on the images for description

Description

Description:

Add an event handler to the given control.

⚠

• Control event handlers are processed in reversed order, i.e. last added: first, first added: last. So if you have an override it should be set up in the 1st added EH.
• When using the event names listed here with the ctrlAddEventHandler, ctrlSetEventHandler, displayAddEventHandler or displaySetEventHandler commands, the prefix "on" in the event name must be removed (e.g. 'ButtonDown' instead of 'onButtonDown').

Groups:

GUI Control - Event HandlersEvent Handlers

Syntax

Syntax:

control ctrlAddEventHandler [handler, function]

Parameters:

control: Control

handler: String - handler name, see User Interface Event Handlers

function: String, since 1.06 also Code - script. Several Magic Variables are available:

• Event Handler parameters are accessible via _this
• The Event Handler type is available as _thisEvent
• The Event Handler index is available as _thisEventHandler

Return Value:

Number - handler ID or -1 if failed

Examples

Example 1:

_map ctrlAddEventHandler ["draw", "_this call BIS_fnc_strategicMapOpen_draw"];

Example 2:

_map ctrlAddEventHandler ["draw", { hintSilent str _this }];

Example 3:

findDisplay 12 displayCtrl 51 ctrlAddEventHandler ["draw", { hintSilent str _this }]; //Arma 3 map control

Additional Information

See also:

displayAddEventHandler ctrlRemoveEventHandler ctrlRemoveAllEventHandlers

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