An overlay for displaying game status on the game client. More...

Inherits MonoBehaviour.

Static Public Member Functions
static void	ShowStatus (string status)
	Show the overlay with a given status message. More...

static void	ShowError (string error)
	Show the overlay with a given error message. More...

static void	Hide ()
	Hide the overlay. More...

Properties
static bool	IsVisible `[get]`
	Gets whether or not the overlay is currently visible. More...

static string	Text `[get, set]`
	Gets the text that the overlay is currently displaying. More...

static StatusOverlayState	State `[get]`
	Gets the current state of the overlay. More...

Detailed Description

An overlay for displaying game status on the game client.

Definition at line 17 of file StatusOverlay.cs.

Member Function Documentation

static void StatusOverlay.Hide ( )

inlinestatic

Hide the overlay.

Definition at line 86 of file StatusOverlay.cs.

static void StatusOverlay.ShowError ( string error )

inlinestatic

Show the overlay with a given error message.

Definition at line 76 of file StatusOverlay.cs.

static void StatusOverlay.ShowStatus ( string status )

inlinestatic

Show the overlay with a given status message.

Definition at line 66 of file StatusOverlay.cs.

bool StatusOverlay.IsVisible

staticget

Gets whether or not the overlay is currently visible.

Definition at line 23 of file StatusOverlay.cs.

StatusOverlayState StatusOverlay.State

staticget

Gets the current state of the overlay.

Definition at line 44 of file StatusOverlay.cs.

string StatusOverlay.Text

staticgetset

Gets the text that the overlay is currently displaying.

Definition at line 31 of file StatusOverlay.cs.

The documentation for this class was generated from the following file: