ctrlSetEventHandler

From Bohemia Interactive Community
Revision as of 12:23, 21 September 2017 by Austin medic (talk | contribs) (Removed impromper brackets in examples section.)
Jump to navigation Jump to search
-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

Description

Description:
Sets given event handler of given control. The provided function should return true/false indicating that the event has handled this event fully or not and whether the engine should execute it's default code or not afterwards. See User Interface Event Handlers for the full list of handler names. If applicable, see DIK_KeyCodes for a list of key code constants, which are relevant to key related user interface events like: KeyDown & KeyUp.
Groups:
Uncategorised

Syntax

Syntax:
controlName ctrlSetEventHandler [handlerName, function]
Parameters:
controlName: Control
[handlerName, function]: Array
handlerName: String
function: String
Return Value:
Nothing

Examples

Example 1:
_control ctrlSetEventHandler ["KeyDown", ""]
Example 2:
(_display displayCtrl 108) ctrlSetEventHandler ["LBSelChanged","['ListChange',_this] call FireEvents"];

Additional Information

See also:
displaySetEventHandlerUI Event HandlersDIK KeyCodes

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

Notes

Unknown
The article User Interface Event Handlers contains a list of event handler names.
Be aware though, that the preceding "on" in the listed names must be eliminated when used with the ctrlSetEventHandler command. e.g. instead of _control ctrlSetEventHandler ["OnLBSelChanged", ""]; // WRONG use _control ctrlSetEventHandler ["LBSelChanged", ""]; // RIGHT

Bottom Section