UISystem

Documents the UISystem class and its functions.

NOT DOCUMENTED We currently don't have information on how these functions work. They are being documented here for visibility.

Invoking UISystem

To invoke the UI system, use the following Global function:

uis = Game.GetUISystem()

Sub-functions

ClearGlobalThemeOverride

ClearGlobalThemeOverride

ClearGlobalThemeOverride();

Info & Usage

HideTutorialBracket

HideTutorialBracket

HideTutorialBracket(bracketID : CName);

Info & Usage

HideTutorialOverlay

HideTutorialOverlay

HideTutorialOverlay(data : TutorialOverlayData);

Info & Usage

PopGameContext

PopGameContext

PopGameContext(context : UIGameContext);

Info & Usage

PushGameContext

PushGameContext

PushGameContext(context : UIGameContext);

Info & Usage

QueueEvent

QueueEvent

QueueEvent(evt : ref:Event);

Info & Usage

RequestNewVisualState

RequestNewVisualState

RequestNewVisualState(newVisualState : CName);

Info & Usage

RequestVendorMenu

RequestVendorMenu

RequestVendorMenu(data : ref:VendorPanelData, optional scenarioName : CName);

Info & Usage

ResetGameContext

ResetGameContext

ResetGameContext();

Info & Usage

RestorePreviousVisualState

RestorePreviousVisualState

RestorePreviousVisualState(popVisualState : CName);

Info & Usage

SetGlobalThemeOverride

SetGlobalThemeOverride

SetGlobalThemeOverride(themeID : CName);

Info & Usage

ShowTutorialBracket

ShowTutorialBracket

ShowTutorialBracket(data : TutorialBracketData);

Info & Usage

ShowTutorialOverlay

ShowTutorialOverlay

ShowTutorialOverlay(data : TutorialOverlayData);

Info & Usage

SwapGameContext

SwapGameContext

SwapGameContext(oldContext : UIGameContext, newContext : UIGameContext);

Info & Usage