Base GameState class that all other game states derive from, defines basic GameState behaviour. More...

Inheritance diagram for TriDevs.TriEngine.StateManagement.GameState:

Collaboration diagram for TriDevs.TriEngine.StateManagement.GameState:

Public Member Functions
virtual void	Update ()
	Updates the object. More...

virtual void	Draw ()
	Draw the object to screen. More...

virtual void	Load ()
	Loads resources associated with this game component. More...

virtual void	Unload ()
	Unloads resources that were loaded in the Load method. More...

virtual void	Pause ()
	Pauses the game state, preventing update calls from running. More...

virtual void	Unpause ()
	Unpauses the game state, enabling update calls again. More...

IGameComponent	AddComponent (IGameComponent component)
	Adds a game component to this game state. More...

void	RemoveComponent (IGameComponent component)
	Removes the specified component from this game state. More...

void	RemoveAllComponents ()
	Removes all components from the game state. More...

void	RemoveAllComponents (Type type)
	Removes all components of the specified type from the game state. More...

void	RemoveAllComponents (Predicate< IGameComponent > predicate)
	Removes all components that match the supplied predicate function. More...

bool	HasComponent (IGameComponent component)
	Returns whether this game state contains the specified IGameComponent. More...

bool	HasComponent (Type type)
	Returns whether this game state contains a specific type of component. More...

bool	HasComponent (Func< IGameComponent, bool > func)
	Returns whether this game state contains a component that matches the supplied predicate. More...

IEnumerable< IGameComponent >	GetAllComponents ()
	Returns a read-only collection of all components in this game state. More...

IGameComponent	GetComponent (Type type)
	Returns the specified component type if it exists in this game state. More...

IEnumerable< IGameComponent >	GetAllComponents (Type type)
	Returns all components of the specified type. More...

IGameComponent	GetComponent (Func< IGameComponent, bool > func)
	Returns the first component that matches the supplied predicate function. More...

IEnumerable< IGameComponent >	GetAllComponents (Func< IGameComponent, bool > func)
	Returns all components that matches the supplied predicate function. More...

Protected Member Functions
	GameState ()

Protected Attributes
readonly List< IGameComponent >	Components
	List of components currently added to this GameState. More...

Properties
bool	Paused `[get, set]`

Properties inherited from TriDevs.TriEngine.StateManagement.IGameState
bool	Paused `[get, set]`
	Gets or sets a value indicating whether this game state is currently paused. More...

Detailed Description

Base GameState class that all other game states derive from, defines basic GameState behaviour.

Constructor & Destructor Documentation

TriDevs.TriEngine.StateManagement.GameState.GameState ( )

protected

         {
             Components = new List<IGameComponent>();
         }

Member Function Documentation

IGameComponent TriDevs.TriEngine.StateManagement.GameState.AddComponent ( IGameComponent component )

Adds a game component to this game state.

Parameters

component The component to add.

Returns: The component that was added.

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             if (HasComponent(component))
                 throw new InvalidOperationException("Cannot add the same component more than once.");
             
             Components.Add(component);
             component.Enable();
             return component; // var comp = someState.AddComponent(new SomeComponent());
         }

Here is the call graph for this function:

virtual void TriDevs.TriEngine.StateManagement.GameState.Draw ( )

virtual

Draw the object to screen.

Implements TriDevs.TriEngine.Interfaces.IDrawable.

         {
             foreach (var component in Components.OfType<IDrawableGameComponent>())
                 component.Draw();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

IEnumerable<IGameComponent> TriDevs.TriEngine.StateManagement.GameState.GetAllComponents ( )

Returns a read-only collection of all components in this game state.

Returns: Read-only collection of components.

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             return Components.AsReadOnly();
         }

IEnumerable<IGameComponent> TriDevs.TriEngine.StateManagement.GameState.GetAllComponents ( Type type )

Returns all components of the specified type.

Parameters

type	The type of game component requested.

Returns: A collection of all components of matching type.

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             return Components.FindAll(c => c.GetType() == type);
         }

IEnumerable<IGameComponent> TriDevs.TriEngine.StateManagement.GameState.GetAllComponents ( Func< IGameComponent, bool > func )

Returns all components that matches the supplied predicate function.

Parameters

func	The predicate function.

Returns: Collection of all matching components, empty collection if no matches were found.

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             return Components.Where(func);
         }

IGameComponent TriDevs.TriEngine.StateManagement.GameState.GetComponent ( Type type )

Returns the specified component type if it exists in this game state.

Parameters

type	The component type to get.

Returns: The component object, or null if it's not added to this game state.

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             return Components.FirstOrDefault(c => c.GetType() == type);
         }

IGameComponent TriDevs.TriEngine.StateManagement.GameState.GetComponent ( Func< IGameComponent, bool > func )

Returns the first component that matches the supplied predicate function.

Parameters

func	The predicate function.

Returns: Component that matches the predicate, null if no matches were found.

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             return Components.FirstOrDefault(func);
         }

bool TriDevs.TriEngine.StateManagement.GameState.HasComponent ( IGameComponent component )

Returns whether this game state contains the specified IGameComponent.

Parameters

component The component to check for.

Returns: True if the component has been added to this game state, false otherwise.

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             return Components.Contains(component);
         }

bool TriDevs.TriEngine.StateManagement.GameState.HasComponent ( Type type )

Returns whether this game state contains a specific type of component.

Parameters

type	The type to check for.

Returns: True if the type of component has been added to this game state, false otherwise.

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             return Components.Any(c => c.GetType() == type);
         }

bool TriDevs.TriEngine.StateManagement.GameState.HasComponent ( Func< IGameComponent, bool > func )

Returns whether this game state contains a component that matches the supplied predicate.

Parameters

func	Predicate function to use for search.

Returns: True if the game state contains a matching component, false otherwise.

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             return Components.Any(func);
         }

virtual void TriDevs.TriEngine.StateManagement.GameState.Load ( )

virtual

Loads resources associated with this game component.

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             
         }

virtual void TriDevs.TriEngine.StateManagement.GameState.Pause ( )

virtual

Pauses the game state, preventing update calls from running.

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             Paused = true;
         }

void TriDevs.TriEngine.StateManagement.GameState.RemoveAllComponents ( )

Removes all components from the game state.

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             Components.ForEach(c => c.Disable());
             Components.Clear();
         }

void TriDevs.TriEngine.StateManagement.GameState.RemoveAllComponents ( Type type )

Removes all components of the specified type from the game state.

Parameters

type	The type of component to remove.

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             RemoveAllComponents(c => c.GetType() == type);
         }

void TriDevs.TriEngine.StateManagement.GameState.RemoveAllComponents ( Predicate< IGameComponent > predicate )

Removes all components that match the supplied predicate function.

Parameters

predicate The predicate function.

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             var removed = Components.FindAll(predicate);
             if (removed.Count < 1)
                 return;
 
             Components.RemoveAll(predicate);
             removed.ForEach(c => c.Disable());
         }

void TriDevs.TriEngine.StateManagement.GameState.RemoveComponent ( IGameComponent component )

Removes the specified component from this game state.

Parameters

component

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             var match = Components.FirstOrDefault(c => c == component);
             if (match == null)
                 return;
 
             Components.Remove(match);
             match.Disable();
         }

Here is the call graph for this function:

virtual void TriDevs.TriEngine.StateManagement.GameState.Unload ( )

virtual

Unloads resources that were loaded in the Load method.

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             
         }

virtual void TriDevs.TriEngine.StateManagement.GameState.Unpause ( )

virtual

Unpauses the game state, enabling update calls again.

Implements TriDevs.TriEngine.StateManagement.IGameState.

         {
             Paused = false;
         }

virtual void TriDevs.TriEngine.StateManagement.GameState.Update ( )

virtual

Updates the object.

Implements TriDevs.TriEngine.Interfaces.IUpdatable.

         {
             Components.ForEach(c => c.Update());
         }

Member Data Documentation

readonly List<IGameComponent> TriDevs.TriEngine.StateManagement.GameState.Components

protected

List of components currently added to this GameState.

Property Documentation

bool TriDevs.TriEngine.StateManagement.GameState.Paused

getset

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

TriDevs.TriEngine/StateManagement/GameState.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation