Event Handlers/inGameUISetEventHandler – Arma 3
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Some wiki formatting) |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
Line 1: | Line 1: | ||
{{TOC|side}} | {{TOC|side}} | ||
In Game UI Event Handlers trigger when user scrolls or activates in game action menu. Additionally a [[Boolean]] or [[Nothing]] is expected to be returned by the assigned code. If the assigned EH code returns [[true]], default engine action is overridden. For all other available EHs see the [[Arma_3:_Event_Handlers|main page]]. | In Game UI Event Handlers trigger when user scrolls or activates in game action menu. Additionally a [[Boolean]] or [[Nothing]] is expected to be returned by the assigned code. If the assigned EH code returns [[true]], default engine action is overridden. For all other available EHs see the [[Arma_3:_Event_Handlers|main page]]. | ||
{{Feature|important|Arguments were introduced with {{GVI|arma3|1.50}}.}} | |||
Line 18: | Line 20: | ||
== Events == | == Events == | ||
{| class="wikitable | {| class="wikitable" | ||
! Class | ! Class | ||
! | ! Description | ||
! | ! Arguments - since {{GVI|arma3|1.50}} | ||
|- | |- | ||
| | | | ||
==== PrevAction ==== | ==== PrevAction ==== | ||
| | | Triggers on mouse wheel scroll up. | ||
Triggers on mouse wheel scroll up. | | rowspan="3" | | ||
| < | <sqf>params ["_target", "_caller", "_index", "_name", "_text", "_priority", "_showWindow", "_hideOnUse", "_shortcut", "_visibility", "_eventName"];</sqf> | ||
* [[Object]] - target object to which action is attached | * [[Object]] - target object to which action is attached | ||
* [[Object]] - caller object, basically [[player]] | * [[Object]] - caller object, basically [[player]] | ||
Line 42: | Line 42: | ||
* [[Boolean]] - action menu visibility (on first scroll or action press the menu is still invisible, so no action is performed, only menu is shown) | * [[Boolean]] - action menu visibility (on first scroll or action press the menu is still invisible, so no action is performed, only menu is shown) | ||
* [[String]] - EH event name | * [[String]] - EH event name | ||
|- | |- | ||
| | | | ||
==== Action ==== | ==== Action ==== | ||
| | | Triggers on action key press. | ||
Triggers on action key press. | |||
|- | |- | ||
| | | | ||
==== NextAction ==== | ==== NextAction ==== | ||
| | | Triggers on mouse wheel scroll down. | ||
Triggers on mouse wheel scroll down. | |||
|} | |} | ||
[[Category:Introduced with Armed Assault version 1.00]] |
Latest revision as of 23:47, 21 July 2022
In Game UI Event Handlers trigger when user scrolls or activates in game action menu. Additionally a Boolean or Nothing is expected to be returned by the assigned code. If the assigned EH code returns true, default engine action is overridden. For all other available EHs see the main page.
Related Commands
Examples
inGameUISetEventHandler ["Action", "hint 'Lights, Camera, Action!'"]; // add EH
inGameUISetEventHandler ["Action", ""]; // remove EH
Events
Class | Description | Arguments - since 1.50 |
---|---|---|
PrevAction |
Triggers on mouse wheel scroll up. |
params ["_target", "_caller", "_index", "_name", "_text", "_priority", "_showWindow", "_hideOnUse", "_shortcut", "_visibility", "_eventName"];
|
Action |
Triggers on action key press. | |
NextAction |
Triggers on mouse wheel scroll down. |