ctrlSetEventHandler: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "Category:Scripting Commands ArmA2" to "Category:Scripting Commands Arma 2") |
m (moved note into description. Fixed formatting) |
||
| Line 13: | Line 13: | ||
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. | ||
If applicable, see [[DIK_KeyCodes]] for a list of key code constants, which are relevant to key related user interface events like: [[User_Interface_Event_Handlers#onKeyDown|KeyDown]] & [[User_Interface_Event_Handlers#onKeyUp|KeyUp]]. |DESCRIPTION= | If applicable, see [[DIK_KeyCodes]] for a list of key code constants, which are relevant to key related user interface events like: [[User_Interface_Event_Handlers#onKeyDown|KeyDown]] & [[User_Interface_Event_Handlers#onKeyUp|KeyUp]]. | ||
{{Important|When using the event names listed below with the [[ctrlAddEventHandler]], [[ctrlSetEventHandler]], [[displayAddEventHandler]] or [[displaySetEventHandler]] commands, the prefix "on" in the name must be removed (e.g. ''''ButtonDown'''' instead of ''''onButtonDown'''').}}|DESCRIPTION= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 26: | Line 27: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= < | |x1= <code>_control [[ctrlSetEventHandler]] ["KeyDown", ""]</code> |EXAMPLE1= | ||
|x2= < | |x2= <code>(_display [[displayCtrl]] 108) [[ctrlSetEventHandler]] ["LBSelChanged","['ListChange',_this] [[call]] FireEvents"];</code> |EXAMPLE2= | ||
| Line 36: | Line 37: | ||
}} | }} | ||
[[Category:Scripting Commands|CTRLSETEVENTHANDLER]] | [[Category:Scripting Commands|CTRLSETEVENTHANDLER]] | ||
Revision as of 10:21, 20 March 2020
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:
- 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