Arma 3: Event Handlers/inGameUISetEventHandler

From Bohemia Interactive Community
Jump to: navigation, search

In Game UI Event Handlers

Description

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

PrevAction

Triggers on mouse wheel scroll up.

Since
Introduced with Arma 3 version 1.50
  • Object - target object to which action is attached
  • Object - caller object, basically player
  • Number - index of the action in action menu (0 - top most)
  • String - engine based action name ("User" for user added actions)
  • String - localized action plain text as seen by the caller
  • Number - action priority value
  • Boolean - action showWindow value
  • Boolean - action hideOnUse value
  • String - action shortcut name or ""
  • 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
Introduced with Armed Assault version 1.0

Action

Triggers on action key press.

Since
Introduced with Arma 3 version 1.50
  • Object - target object to which action is attached
  • Object - caller object, basically player
  • Number - index of the action in action menu (0 - top most)
  • String - engine based action name ("User" for user added actions)
  • String - localized action plain text as seen by the caller
  • Number - action priority value
  • Boolean - action showWindow value
  • Boolean - action hideOnUse value
  • String - action shortcut name or ""
  • 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
Introduced with Armed Assault version 1.0

NextAction

Triggers on mouse wheel scroll down.

Since
Introduced with Arma 3 version 1.50
  • Object - target object to which action is attached
  • Object - caller object, basically player
  • Number - index of the action in action menu (0 - top most)
  • String - engine based action name ("User" for user added actions)
  • String - localized action plain text as seen by the caller
  • Number - action priority value
  • Boolean - action showWindow value
  • Boolean - action hideOnUse value
  • String - action shortcut name or ""
  • 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
Introduced with Armed Assault version 1.0