addUserActionEventHandler: Difference between revisions

From Bohemia Interactive Community
mNo edit summary
(Fix _thisEvent v2.20 information)
Line 25: Line 25:
{{Feature|important
{{Feature|important
|The magic variable {{hl|{{Link|Magic Variables#thisEvent|_thisEvent}}}} is available in these event handlers but can only return one of these three values:
|The magic variable {{hl|{{Link|Magic Variables#thisEvent|_thisEvent}}}} is available in these event handlers but can only return one of these three values:
* {{hl|"KeyActivateEH"}}
* {{hl|"Activate"}}
* {{hl|"KeyDeactivateEH"}}
* {{hl|"Deactivate"}}
* {{hl|"KeyAnalogEH"}}
* {{hl|"Analog"}}
'''This is prone to change in {{arma3}} v2.20!'''
}}
}}
</spoiler>
</spoiler>

Revision as of 12:55, 10 March 2026

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.
The Event Handler index is available as _thisEventHandler during Event Handler code execution.
The magic variable _thisEvent is available in these event handlers but can only return one of these three values:
  • "Activate"
  • "Deactivate"
  • "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