addUserActionEventHandler: Difference between revisions

Latest revision as of 14:05, 10 March 2026

2.06

LELocal

Hover & click on the images for description

Description

Description:: Adds a user action event handler to the current mission and returns its event handler index.
Groups:: Event Handlers

Syntax

Syntax:

addUserActionEventHandler [keyName, event, expression]

Parameters:

keyName: String - action key name - see inputAction/actions

event: String - event name - see UserAction Event Handlers. Can be one of:

"Activate"
"Deactivate"
"Analog"

expression: Code - expression that will be executed in missionNamespace when event handler fires.

_thisEventHandler returns the event handler index
_thisEvent returns the event type (the event parameter, either "Activate", "Deactivate" or "Analog")

Return Value:

Number - the index of the currently added UserAction event handler is returned

Examples

Example 1:: private _ehId = addUserActionEventHandler ["ReloadMagazine", "Activate", { systemChat "reloading!"; }];

Additional Information

See also:: removeUserActionEventHandler removeAllUserActionEventHandlers UserAction Event Handlers

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note

@@ Line 8: / Line 8: @@
 |gr1= Event Handlers
-|descr= Adds event handler attached to the current mission and returns event handler handle.
+|descr= Adds a user action event handler to the current mission and returns its event handler index.
-|s1= [[addUserActionEventHandler]]  [keyName, event, expression]
+|s1= [[addUserActionEventHandler]] [keyName, event, expression]
 |p1= keyName: [[String]] - action key name - see [[inputAction/actions]]
 |p2= event: [[String]] - event name - see [[Arma 3: Event Handlers#UserAction Event Handlers|UserAction Event Handlers]]. Can be one of:
-* "Activate"
+* {{hl|"Activate"}}
-* "Deactivate"
+* {{hl|"Deactivate"}}
-* "Analog"
+* {{hl|"Analog"}}
-|p3= expression: [[Code]] - Expression that will be executed in [[missionNamespace]] when event handler fires.
+|p3= expression: [[Code]] - expression that will be executed in [[missionNamespace]] when event handler fires.
-{{Feature | important | ''expression'' can only be [[Code]], '''not''' [[String]].}}
+* {{hl|{{Link|Magic Variables#thisEventHandler|_thisEventHandler}}}} returns the event handler index
+* {{hl|{{Link|Magic Variables#thisEvent|_thisEvent}}}} returns the event type (the ''event'' parameter, either {{hl|"Activate"}}, {{hl|"Deactivate"}} or {{hl|"Analog"}})
-|r1= [[Number]] - The index of the currently added UserAction event handler is returned
+|r1= [[Number]] - the index of the currently added UserAction event handler is returned
-|x1= <code>[[private]] _ehId = [[addUserActionEventHandler]] ["Reload", "Activate", { [[systemChat]] "reloading!"; }];</code>
+|x1= <sqf>private _ehId = addUserActionEventHandler ["ReloadMagazine", "Activate", { systemChat "reloading!"; }];</sqf>
 |seealso= [[removeUserActionEventHandler]] [[removeAllUserActionEventHandlers]] [[Arma 3: Event Handlers#UserAction Event Handlers|UserAction Event Handlers]]
 }}