TriDevs.TriEngine.StateManagement.GameStateManager Class Reference

Game state manager that keeps track of the active game states and provides methods to control the states. More...

Inheritance diagram for TriDevs.TriEngine.StateManagement.GameStateManager:

Collaboration diagram for TriDevs.TriEngine.StateManagement.GameStateManager:

Public Member Functions
	GameStateManager ()
	Creates a new GameStateManager with an empty state stack. More...
	GameStateManager (IGameState state)
	Creates a new GameStateManager and pushes an initial state onto the stack. More...
void	Update ()
	Updates the object. More...
void	Draw ()
	Draw the object to screen. More...
IGameState	Push (IGameState state)
	Pushes a new game state onto the stack, pausing the current one. More...
IGameState	Pop ()
	Pops the currently active state from the stack, unpausing the previous one. More...
IGameState	Peek ()
	Returns the game state at the top of the stack, without popping it. More...
IGameState	Switch (IGameState state)
	Switches to a new game state, discarding all previous ones in the stack. More...

Properties
int	StateCount [get]
IGameState	ActiveState [get, set]
Properties inherited from TriDevs.TriEngine.StateManagement.IGameStateManager
int	StateCount [get]
	Gets the number of game states currently in the stack. More...
IGameState	ActiveState [get]
	Gets the currently active game state. More...

Detailed Description

Game state manager that keeps track of the active game states and provides methods to control the states.

Constructor & Destructor Documentation

TriDevs.TriEngine.StateManagement.GameStateManager.GameStateManager

(

)

Creates a new GameStateManager with an empty state stack.

        {
            _states = new Stack<IGameState>();
        }

TriDevs.TriEngine.StateManagement.GameStateManager.GameStateManager

(

IGameState

state

)

Creates a new GameStateManager and pushes an initial state onto the stack.

Parameters

state

The state to initialize with.

                                                  : this()
        {
            Push(state);
        }

Member Function Documentation

void TriDevs.TriEngine.StateManagement.GameStateManager.Draw

(

)

Draw the object to screen.

Implements TriDevs.TriEngine.Interfaces.IDrawable.

        {
            if (ActiveState != null)
                ActiveState.Draw();
        }

IGameState TriDevs.TriEngine.StateManagement.GameStateManager.Peek

(

)

Returns the game state at the top of the stack, without popping it.

Returns

The state at the top of the stack.

Implements TriDevs.TriEngine.StateManagement.IGameStateManager.

        {
            return _states.Peek();
        }

IGameState TriDevs.TriEngine.StateManagement.GameStateManager.Pop

(

)

Pops the currently active state from the stack, unpausing the previous one.

Returns

The state that was popped.

Implements TriDevs.TriEngine.StateManagement.IGameStateManager.

        {
            if (_states.Count == 1)
                throw new InvalidOperationException("Cannot pop the last remaining game state from stack.");

            var state = _states.Pop();
            state.Unload();
            ActiveState = _states.Peek();
            ActiveState.Unpause();
            return state;
        }

IGameState TriDevs.TriEngine.StateManagement.GameStateManager.Push

(

IGameState

state

)

Pushes a new game state onto the stack, pausing the current one.

Parameters

state

The new game state to push onto the stack.

Returns

The game state that was pushed.

Implements TriDevs.TriEngine.StateManagement.IGameStateManager.

        {
            if (ActiveState != null)
                ActiveState.Pause();

            state.Load();
            _states.Push(state);
            ActiveState = state;
            return state;
        }

Here is the call graph for this function:

IGameState TriDevs.TriEngine.StateManagement.GameStateManager.Switch

(

IGameState

state

)

Switches to a new game state, discarding all previous ones in the stack.

Parameters

state

The new state to switch to.

Returns

The state that was switched to.

Implements TriDevs.TriEngine.StateManagement.IGameStateManager.

        {
            while (_states.Count > 0)
                _states.Pop().Unload();

            _states = new Stack<IGameState>();
            return Push(state);
        }

Here is the call graph for this function:

void TriDevs.TriEngine.StateManagement.GameStateManager.Update

(

)

Updates the object.

Implements TriDevs.TriEngine.Interfaces.IUpdatable.

        {
            if (ActiveState != null)
                ActiveState.Update();
        }

Property Documentation

IGameState TriDevs.TriEngine.StateManagement.GameStateManager.ActiveState

getset

int TriDevs.TriEngine.StateManagement.GameStateManager.StateCount

get

---

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

• TriDevs.TriEngine/StateManagement/GameStateManager.cs