game::state::State Class Reference

Parent to all game states. Provides some commonly required data like core game systems. More...

#include <State.hpp>

Inheritance diagram for game::state::State:

Public Member Functions
virtual	~State ()=default
	Destroy the State object. More...
virtual const char *	name () const override=0
	Return the name of the state. More...
virtual void	activate (bl::engine::Engine &engine) override=0
	Make the state active. This is called before update() or render() and called exactly once until deactivate() is called. More...
virtual void	deactivate (bl::engine::Engine &engine) override=0
	The state is now not the current state. Called after activate() More...
virtual void	update (bl::engine::Engine &engine, float dt, float realDt) override=0
	Perform all update logic as required in here. More...

Protected Member Functions
	State (core::system::Systems &systems, bl::engine::StateMask::V mask)
	Initialize the state. More...

Protected Attributes
core::system::Systems &	systems

Detailed Description

Parent to all game states. Provides some commonly required data like core game systems.

Definition at line 29 of file State.hpp.

Constructor & Destructor Documentation

~State()

virtual game::state::State::~State ( )

virtualdefault

Destroy the State object.

State()

game::state::State::State ( core::system::Systems &  systems, bl::engine::StateMask::V  mask  )

protected

Initialize the state.

Parameters

systems	A reference to the core game systems
mask	The state mask

Definition at line 7 of file State.cpp.

Member Function Documentation

activate()

virtual void game::state::State::activate ( bl::engine::Engine &  engine )

overridepure virtual

Make the state active. This is called before update() or render() and called exactly once until deactivate() is called.

Parameters

engine

The active engine

Implemented in game::state::StoreMenu, game::state::StorageSystem, game::state::SettingsMenu, game::state::SaveGame, game::state::PeoplemonMenu, game::state::PeoplemonInfo, game::state::Peopledex, game::state::NewGame, game::state::MapExplorer, game::state::MainMenu, game::state::MainGame, game::state::LoadGame, game::state::FlyMap, game::state::Evolution, game::state::BattleWrapperState, game::state::PauseMenu, game::state::BattleState, and game::state::BagMenu.

deactivate()

virtual void game::state::State::deactivate ( bl::engine::Engine &  engine )

overridepure virtual

The state is now not the current state. Called after activate()

Parameters

engine

The active engine

Implemented in game::state::StoreMenu, game::state::StorageSystem, game::state::SettingsMenu, game::state::SaveGame, game::state::PeoplemonMenu, game::state::PeoplemonInfo, game::state::Peopledex, game::state::NewGame, game::state::MapExplorer, game::state::MainMenu, game::state::MainGame, game::state::LoadGame, game::state::FlyMap, game::state::Evolution, game::state::BattleWrapperState, game::state::PauseMenu, game::state::BattleState, and game::state::BagMenu.

name()

virtual const char* game::state::State::name ( ) const

overridepure virtual

Return the name of the state.

Implemented in game::state::StoreMenu, game::state::StorageSystem, game::state::SettingsMenu, game::state::SaveGame, game::state::PeoplemonMenu, game::state::PeoplemonInfo, game::state::Peopledex, game::state::PauseMenu, game::state::NewGame, game::state::MapExplorer, game::state::MainMenu, game::state::MainGame, game::state::LoadGame, game::state::FlyMap, game::state::Evolution, game::state::BattleWrapperState, game::state::BattleState, and game::state::BagMenu.

update()

virtual void game::state::State::update ( bl::engine::Engine &  engine, float  dt, float  realDt  )

overridepure virtual

Perform all update logic as required in here.

Parameters

engine	The active engine
dt	The elapsed simulated time since the last call to update
realDt	The elapsed real time since the last call to update

Implemented in game::state::StoreMenu, game::state::StorageSystem, game::state::SettingsMenu, game::state::SaveGame, game::state::PeoplemonInfo, game::state::Peopledex, game::state::NewGame, game::state::MapExplorer, game::state::MainGame, game::state::LoadGame, game::state::FlyMap, game::state::Evolution, game::state::BattleWrapperState, game::state::PeoplemonMenu, game::state::PauseMenu, game::state::MainMenu, game::state::BattleState, and game::state::BagMenu.

Member Data Documentation

systems

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

protected

Definition at line 66 of file State.hpp.

---

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

• include/Game/States/State.hpp
• src/Game/States/State.cpp