Interface: IXR_ActorMenu
Actor/PDA menu namespace exposed to scripts.
Source
namespace ActorMenu
Remarks
These helpers dereference CurrentGameUI() directly. Use them only in-game after the HUD UI has been created.
Methods
get_actor_menu()
get_actor_menu(this: void): CUIActorMenu;Get the current actor menu window.
Parameters
| Parameter | Type |
|---|---|
this | void |
Returns
Actor menu window.
Throws
When called without an active current game UI.
get_maingame()
get_maingame(this: void): unknown;Get the current main in-game HUD window.
Parameters
| Parameter | Type |
|---|---|
this | void |
Returns
unknown
Main in-game HUD window pointer.
Source
src/xrGame/ui/UIActorMenu_script.cpp, ActorMenu.get_maingame.
Remarks
The concrete CUIMainIngameWnd class is not declared as a Lua binding, so the returned pointer is typed as unknown.
Throws
When called without an active current game UI.
get_menu_mode()
get_menu_mode(this: void): number;Get current actor menu mode.
Parameters
| Parameter | Type |
|---|---|
this | void |
Returns
number
Numeric EMenuMode value.
Throws
When called without an active current game UI.
get_pda_menu()
get_pda_menu(this: void): CUIPdaWnd;Get the current PDA menu window.
Parameters
| Parameter | Type |
|---|---|
this | void |
Returns
PDA menu window.
Throws
When called without an active current game UI.