UIWindow Class Reference

This class facilitates an easy way of switching between different windows. Use UIWindow.Show(panel) to show a window and UIWindow.GoBack() to go back to the previous one. More...

Inheritance diagram for UIWindow:

Static Public Member Functions
static void	Add (UIPanel window)
	Ensure that the specified window has been added to the list. More...
static void	Show (UIPanel window)
	Show the specified window. More...
static void	Hide (UIPanel window)
	Hide the specified window, but only if the window is currently visible. If it's not, do nothing. More...
static void	GoBack ()
	Return to the previous window. More...
static void	Close ()
	Hide the current window and clear the history. More...
static void	Close (GameObject go)
	Hide the current window and clear the history. More...
static void	Close (UIPanel panel)
	Hide the current window and clear the history. More...

Static Public Attributes
static AudioClip	showSound
	Sound to play when showing any window. More...
static AudioClip	hideSound
	Sound to play when hiding any window. More...

Properties
static UIPanel	current [get]
	Currently visible window. More...

Detailed Description

This class facilitates an easy way of switching between different windows. Use UIWindow.Show(panel) to show a window and UIWindow.GoBack() to go back to the previous one.

Member Function Documentation

static void UIWindow.Add ( UIPanel  window )

static

Ensure that the specified window has been added to the list.

static void UIWindow.Close ( )

static

Hide the current window and clear the history.

static void UIWindow.Close ( GameObject  go )

static

Hide the current window and clear the history.

static void UIWindow.Close ( UIPanel  panel )

static

Hide the current window and clear the history.

static void UIWindow.GoBack ( )

static

Return to the previous window.

static void UIWindow.Hide ( UIPanel  window )

static

Hide the specified window, but only if the window is currently visible. If it's not, do nothing.

static void UIWindow.Show ( UIPanel  window )

static

Show the specified window.

Member Data Documentation

AudioClip UIWindow.hideSound

static

Sound to play when hiding any window.

AudioClip UIWindow.showSound

static

Sound to play when showing any window.

Property Documentation

UIPanel UIWindow.current

staticget

Currently visible window.

---

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

• Game/Scripts/UI/UIWindow.cs