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

Provides the main menu as an engine state. More...

#include <MainMenu.hpp>

+ Inheritance diagram for game::state::MainMenu:

Public Member Functions

virtual ~MainMenu ()=default
 Cleans up all resources. More...
 
virtual const char * name () const override
 Returns "MainMenu";. More...
 
virtual void activate (bl::engine::Engine &engine) override
 Subscribes the menu to the engine event bus. More...
 
virtual void deactivate (bl::engine::Engine &engine) override
 Unsubscribes the menu to the engine event bus. More...
 
virtual void update (bl::engine::Engine &, float dt, float) override
 Does nothing. More...
 

Static Public Member Functions

static bl::engine::State::Ptr create (core::system::Systems &systems)
 Creates a new MainMenu state. More...
 

Protected Attributes

core::system::Systemssystems
 

Detailed Description

Provides the main menu as an engine state.

Definition at line 20 of file MainMenu.hpp.

Constructor & Destructor Documentation

◆ ~MainMenu()

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

Cleans up all resources.

Member Function Documentation

◆ activate()

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

Subscribes the menu to the engine event bus.

Implements game::state::State.

Definition at line 28 of file MainMenu.cpp.

◆ create()

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

Creates a new MainMenu state.

Definition at line 18 of file MainMenu.cpp.

◆ deactivate()

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

Unsubscribes the menu to the engine event bus.

Implements game::state::State.

Definition at line 133 of file MainMenu.cpp.

◆ name()

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

Returns "MainMenu";.

Implements game::state::State.

Definition at line 26 of file MainMenu.cpp.

◆ update()

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

Does nothing.

Implements game::state::State.

Definition at line 138 of file MainMenu.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: