Screen2DManager Class Reference

List of all members.

Public Member Functions
virtual void	ScreenDidClose (Screen2D screen)
virtual void	ScreenDidOpen (Screen2D screen)
virtual void	ScreenDidCollapse (Screen2D screen)
virtual void	ScreenDidExpand (Screen2D screen)
virtual void	TransitionDidBegin ()
virtual void	TransitionDidEnd ()
void	Launch ()
void	OpenScreenWithCustomTransition (Screen2D screen)
void	OpenScreen (int id)
void	QueueScreen (int id)
void	OpenQueuedScreen ()
void	OpenQueuedScreenCustom ()
void	CloseScreen ()
void	CloseScreen (int id)
Public Attributes
Screen2D[]	screens
Screen2D	_default
Protected Member Functions
virtual void	Init ()

---

Detailed Description

This class is abstract and should be used as a base to manager your Screen2D Game Objects.

Note: This class uses Awake for its own initialization purposes. When extending this class do not use Awake, override and use Init() instead. Init() is called from Awake() to maintain execution order.

---

Member Function Documentation

void Screen2DManager.CloseScreen

(

)

Closes the open screen.

void Screen2DManager.CloseScreen

(

int

id

)

Closes the Screen with the specified id.

virtual void Screen2DManager.Init

(

)

[protected, virtual]

This class uses Awake() for its own initialization purposes. When extending this class do not use Awake(), but use Init() instead. Init() is called from Awake() to maintain execution order.

void Screen2DManager.Launch

(

)

Launch is where your menu should begin. This effectively opens your menu.

If there is no screen currently deamed open, it assigns the default screen to open and calls Screen2D.Open on it,

void Screen2DManager.OpenQueuedScreen

(

)

Opens the queued screen if there is one by calling Screen2D.Open()

void Screen2DManager.OpenQueuedScreenCustom

(

)

Opens the queued screen if there is one, but unlike OpenQueuedScreen, this calls Screen2D.OpenWithCustomTransition()

void Screen2DManager.OpenScreen

(

int

id

)

Opens the screen with the specified id.

void Screen2DManager.OpenScreenWithCustomTransition

(

Screen2D

screen

)

This will bypass transitions if you aren't using them. This should be your alternative to Launch(). Sets the provided Screen2D screen as the open screen and calls OpenWithCustomTransition() on it.

void Screen2DManager.QueueScreen

(

int

id

)

This stores the screen with the provided id so that you can open it later. Call this method when closing a screen so that

virtual void Screen2DManager.ScreenDidClose

(

Screen2D

screen

)

[virtual]

Hook called when a Screen2D closes.

virtual void Screen2DManager.ScreenDidCollapse

(

Screen2D

screen

)

[virtual]

Hook called when a Screen2D collapse.

virtual void Screen2DManager.ScreenDidExpand

(

Screen2D

screen

)

[virtual]

Hook called when a Screen2D expands.

virtual void Screen2DManager.ScreenDidOpen

(

Screen2D

screen

)

[virtual]

Hook called when a Screen2D opens.

virtual void Screen2DManager.TransitionDidBegin

(

)

[virtual]

Hook called when a transition begins. Use this for disabling input and such.

virtual void Screen2DManager.TransitionDidEnd

(

)

[virtual]

Hook called when a transition ends. Use this for enabling input and such.

---

Member Data Documentation

Screen2D Screen2DManager._default

The Screen2D which will open by default.

Screen2D [] Screen2DManager.screens

All the Screen2Ds that make up the User Interface / Menu System.