addUserActionEventHandler: Difference between revisions
Lou Montana (talk | contribs) m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2") |
Lou Montana (talk | contribs) (Add _thisEvent's "prone to change" note) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 10: | Line 10: | ||
|descr= Adds a user action event handler to the current mission and returns its event handler index. | |descr= Adds a user action event handler to the current mission and returns its event handler index. | ||
|s1= [[addUserActionEventHandler]] | |||
|s1= [[addUserActionEventHandler]] [keyName, event, expression] | |||
|p1= keyName: [[String]] - action key name - see [[inputAction/actions]] | |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: | |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.<br> | |p3= expression: '''[[Code]]''' - expression that will be executed in [[missionNamespace]] when event handler fires.<br> | ||
The Event Handler index is available as {{hl|_thisEventHandler}} during Event Handler code execution. | The Event Handler index is available as {{hl|{{Link|Magic Variables#thisEvent|_thisEventHandler}}}} during Event Handler code execution.<br> | ||
{{Feature | important | | <spoiler text="Show _thisEvent information"> | ||
{{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: | |||
* {{hl|"KeyActivateEH"}} | |||
* {{hl|"KeyDeactivateEH"}} | |||
* {{hl|"KeyAnalogEH"}} | |||
'''This is prone to change in {{arma3}} v2.20!''' | |||
}} | |||
</spoiler> | |||
|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 | ||
Latest revision as of 17:25, 6 May 2025
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.
- 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
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