addUserActionEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Some wiki formatting)
(2 intermediate revisions by 2 users not shown)
Line 19: Line 19:
* "Analog"
* "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.<br>
The Event Handler index is available as {{hl|_thisEventHandler}} during Event Handler code execution.
{{Feature | important | ''expression'' can only be [[Code]], '''not''' [[String]].}}
{{Feature | important | ''expression'' can only be [[Code]], '''not''' [[String]].}}


|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]]
|seealso= [[removeUserActionEventHandler]] [[removeAllUserActionEventHandlers]] [[Arma 3: Event Handlers#UserAction Event Handlers|UserAction Event Handlers]]
}}
}}

Revision as of 18:33, 5 May 2022

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.
expression can only be Code, not String.
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 or on the Forums.
Only post proven facts here! Add Note