Peoplemon  0.1.0
Peoplemon 3 game source documentation
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
game::state::MainGame Class Reference

The big honcho. This is the primary state that runs a majority of the time. More...

#include <MainGame.hpp>

+ Inheritance diagram for game::state::MainGame:

Public Member Functions

virtual ~MainGame ()
 Destroy the Main Game state. More...
 
virtual const char * name () const override
 Returns "MainGame". More...
 
virtual void activate (bl::engine::Engine &engine) override
 Activates the state. More...
 
virtual void deactivate (bl::engine::Engine &engine) override
 Deactivates the game state. More...
 
virtual void update (bl::engine::Engine &engine, float dt, float) override
 Updates all of the primary systems. More...
 

Static Public Member Functions

static bl::engine::State::Ptr create (core::system::Systems &systems)
 Creates the main game state. The game state must be initialized before invoking the main game state. More...
 

Protected Attributes

core::system::Systemssystems
 

Detailed Description

The big honcho. This is the primary state that runs a majority of the time.

Definition at line 22 of file MainGame.hpp.

Constructor & Destructor Documentation

◆ ~MainGame()

game::state::MainGame::~MainGame ( )
virtual

Destroy the Main Game state.

Definition at line 45 of file MainGame.cpp.

Member Function Documentation

◆ activate()

void game::state::MainGame::activate ( bl::engine::Engine &  engine)
overridevirtual

Activates the state.

Parameters
engineThe game engine

Implements game::state::State.

Definition at line 49 of file MainGame.cpp.

◆ create()

MainGame::Ptr game::state::MainGame::create ( core::system::Systems systems)
static

Creates the main game state. The game state must be initialized before invoking the main game state.

Parameters
systemsThe primary systems object
Returns
bl::engine::State::Ptr The main game state

Definition at line 35 of file MainGame.cpp.

◆ deactivate()

void game::state::MainGame::deactivate ( bl::engine::Engine &  engine)
overridevirtual

Deactivates the game state.

Parameters
engineThe game engine

Implements game::state::State.

Definition at line 62 of file MainGame.cpp.

◆ name()

const char * game::state::MainGame::name ( ) const
overridevirtual

Returns "MainGame".

Implements game::state::State.

Definition at line 47 of file MainGame.cpp.

◆ update()

void game::state::MainGame::update ( bl::engine::Engine &  engine,
float  dt,
float   
)
overridevirtual

Updates all of the primary systems.

Parameters
engineThe game engine
dtTime to step forward in the game world

Implements game::state::State.

Definition at line 67 of file MainGame.cpp.

Member Data Documentation

◆ systems

core::system::Systems& game::state::State::systems
protectedinherited

Definition at line 66 of file State.hpp.


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