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

#include <SettingsMenu.hpp>

+ Inheritance diagram for game::state::SettingsMenu:

Public Member Functions

virtual ~SettingsMenu ()=default
 Destroy the Settings Menu state. More...
 
virtual const char * name () const override
 Returns "SettingsMenu". More...
 
virtual void activate (bl::engine::Engine &engine) override
 Activates the state. More...
 
virtual void deactivate (bl::engine::Engine &engine) override
 Deactivates the state. More...
 
virtual void update (bl::engine::Engine &engine, float dt, float) override
 Updates the state and menus and whatnot. More...
 

Static Public Member Functions

static bl::engine::State::Ptr create (core::system::Systems &systems)
 Creates the settings menu state. More...
 

Protected Attributes

core::system::Systemssystems
 

Detailed Description

Definition at line 12 of file SettingsMenu.hpp.

Constructor & Destructor Documentation

◆ ~SettingsMenu()

virtual game::state::SettingsMenu::~SettingsMenu ( )
virtualdefault

Destroy the Settings Menu state.

Member Function Documentation

◆ activate()

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

Activates the state.

Parameters
engineThe game engine

Implements game::state::State.

Definition at line 68 of file SettingsMenu.cpp.

◆ create()

bl::engine::State::Ptr game::state::SettingsMenu::create ( core::system::Systems systems)
static

Creates the settings menu state.

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

Definition at line 57 of file SettingsMenu.cpp.

◆ deactivate()

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

Deactivates the state.

Parameters
engineThe game engine

Implements game::state::State.

Definition at line 324 of file SettingsMenu.cpp.

◆ name()

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

Returns "SettingsMenu".

Implements game::state::State.

Definition at line 66 of file SettingsMenu.cpp.

◆ update()

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

Updates the state and menus and whatnot.

Parameters
engineThe game engine
dtTime elapsed in seconds

Implements game::state::State.

Definition at line 332 of file SettingsMenu.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: