ctrlSetEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - " it's" to " it is")
Line 9: Line 9:
| Sets given event handler of given control.
| 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.  
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 is default code or not afterwards.  


See [[User_Interface_Event_Handlers|User Interface Event Handlers]] for the full list of handler names.
See [[User_Interface_Event_Handlers|User Interface Event Handlers]] for the full list of handler names.

Revision as of 09:12, 8 September 2020

-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 is 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.
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:
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:
displaySetEventHandlerctrlAddEventHandlerctrlRemoveEventHandlerUI 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