UIScreenBase

Base class for all UI screen components.

Properties

string ScreenName

• Read-Only

• The name of this screen as identifiable by the UI controller.

bool DisablesControl

• Read-Only

• Whether or not this screen disables the player's controls while it is open.

bool EnablesCursor

• Read-Only

• Whether or not this screen shows the game's cursor while it is open.

bool IsOpen

• Read-Only

• Whether or not this screen is open.

Methods

void CloseScreen()

• Forces the closure of this screen.

void InitScreen(EntityBase playerEntity)

• Initializes this screen with the player entity that will be interacting with it.

• playerEntity The player entity.

void OpenScreen(params object[] args)

• Opens this screen with a set of optional arguments.

• args Optional set of arguments to use when opening.