ctrlAddEventHandler: Difference between revisions

Latest revision as of 11:46, 5 May 2024

1.00

1.50

1.00

0.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 Handlers Event 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

@@ Line 1: / Line 1: @@
-{{Command
+{{RV|type=command
-| arma2
+|game1= arma2
+|version1= 1.00
-|1.00
+|game2= arma2oa
+|version2= 1.50
+|game3= tkoh
+|version3= 1.00
+|game4= arma3
+|version4= 0.50
 |gr1= GUI Control - Event Handlers
 |gr2= Event Handlers
-| Add an event handler ([[User Interface Event Handlers]]) to the given control. Returns id of the handler or -1 when failed.<br><br>
+|descr= Add an event handler to the given control.
-{{ Important | Control EHs 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.}}
-<br>
+{{Feature|important|
-{{Important|When using the event names listed [[User Interface Event Handlers|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'''').}}
+* 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 [[User Interface Event Handlers|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'''').
+}}
-| control '''ctrlAddEventHandler''' [handler,function]
+|s1= control [[ctrlAddEventHandler]] [handler, function]
 |p1= control: [[Control]]
-|p2= [handler,function]: [[Array]]
+|p2= handler: [[String]] - handler name, see [[User Interface Event Handlers]]
-|p3= handler: [[String]] - handler name
+|p3= function: [[String]], since {{GVI|arma3|1.06}} also [[Code]] - script. Several [[Magic Variables]] are available:
+* Event Handler parameters are accessible via {{hl|_this}}
+* The Event Handler type is available as {{hl|_thisEvent}}
+* The Event Handler index is available as {{hl|_thisEventHandler}}
-|p4= function: [[String]] or [[Code]] - script
+|r1= [[Number]] - handler ID or -1 if failed
-| [[Number]]
+|x1= <sqf>_map ctrlAddEventHandler ["draw", "_this call BIS_fnc_strategicMapOpen_draw"];</sqf>
-|x1= <code>_map [[ctrlAddEventHandler]] ["draw","_this call BIS_fnc_strategicMapOpen_draw"];</code>
+|x2= <sqf>_map ctrlAddEventHandler ["draw", { hintSilent str _this }];</sqf>
-|x2= <code>_map [[ctrlAddEventHandler]] ["draw",{[[hintSilent]] [[str]] _this}];</code>
-| [[displayAddEventHandler]], [[ctrlRemoveEventHandler]], [[ctrlRemoveAllEventHandlers]]
+|x3= <sqf>findDisplay 12 displayCtrl 51 ctrlAddEventHandler ["draw", { hintSilent str _this }]; //Arma 3 map control</sqf>
+|seealso= [[displayAddEventHandler]] [[ctrlRemoveEventHandler]] [[ctrlRemoveAllEventHandlers]]
 }}
-<dl class='command_description'>
-<!-- Note Section BEGIN -->
-<dd class="notedate">Posted on October 30, 2013 - 11:14
-<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]<dd class="note">As of Arma 3 v1.05.111658 [[ctrlAddEventHandler]] and [[displayAddEventHandler]] support script [[Code]] in addition to [[String]] [http://forums.bistudio.com/showthread.php?149636-Development-Branch-Changelog&p=2546439&viewfull=1#post2546439]
-<!-- Note Section END -->
-</dl>
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]