ctrlSetEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
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= <pre>_control ctrlSetEventHandler ["KeyDown", ""]</pre> |EXAMPLE1=
|x1= <code>_control [[ctrlSetEventHandler]] ["KeyDown", ""]</code> |EXAMPLE1=


|x2= <pre>(_display displayCtrl 108) ctrlSetEventHandler ["LBSelChanged","['ListChange',_this] call FireEvents"];</pre> |EXAMPLE2= (using call)
|x2= <code>(_display [[displayCtrl]] 108) [[ctrlSetEventHandler]] ["LBSelChanged","['ListChange',_this] [[call]] FireEvents"];</code> |EXAMPLE2=




Line 36: Line 37:


}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<dt class="note">Unknown <dd class="note">The article [[User Interface Event Handlers]] contains a list of event handler names.<br>
Be aware though, that the preceding "on" in the listed names must be eliminated when used with the ctrlSetEventHandler command.
e.g. instead of <code> _control ctrlSetEventHandler ["'''OnLBSelChanged'''", ""]; // '''''WRONG'''''</code>
use
<code> _control ctrlSetEventHandler ["'''LBSelChanged'''", ""]; // '''''RIGHT''''' </code>
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>


[[Category:Scripting Commands|CTRLSETEVENTHANDLER]]
[[Category:Scripting Commands|CTRLSETEVENTHANDLER]]

Revision as of 11:21, 20 March 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'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.
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').
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