game::state::PeoplemonMenu Class Reference

Provides the menu for viewing and selecting Peoplemon. More...

#include <PeoplemonMenu.hpp>

Inheritance diagram for game::state::PeoplemonMenu:

Public Types
using	Context = core::event::OpenPeoplemonMenu::Context

Public Member Functions
virtual	~PeoplemonMenu ()=default
	Cleans up all resources. More...
virtual const char *	name () const override
	Returns "PeoplemonMenu". 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, Context ctx, int outNow=-1, int *chosen=nullptr, core::item::Id item=core::item::Id::None)
	Creates a new PeoplemonMenu state. More...

Protected Attributes
core::system::Systems &	systems

Detailed Description

Provides the menu for viewing and selecting Peoplemon.

Definition at line 21 of file PeoplemonMenu.hpp.

Member Typedef Documentation

Context

using game::state::PeoplemonMenu::Context = core::event::OpenPeoplemonMenu::Context

Definition at line 25 of file PeoplemonMenu.hpp.

Constructor & Destructor Documentation

~PeoplemonMenu()

virtual game::state::PeoplemonMenu::~PeoplemonMenu ( )

virtualdefault

Cleans up all resources.

Member Function Documentation

activate()

void game::state::PeoplemonMenu::activate ( bl::engine::Engine &  engine )

overridevirtual

Subscribes the menu to the engine event bus.

Implements game::state::State.

Definition at line 135 of file PeoplemonMenu.cpp.

create()

bl::engine::State::Ptr game::state::PeoplemonMenu::create ( core::system::Systems &  systems, Context  ctx, int  outNow = -1, int *  chosen = nullptr, core::item::Id  item = core::item::Id::None  )

static

Creates a new PeoplemonMenu state.

Parameters

systems	The main game systems
ctx	The context the menu is being used in
outNow	Optional index of the peoplemon that is currently out
chosen	Value to populate with the selected peoplemon's index
item	The item to use (or being used in battle)

Definition at line 39 of file PeoplemonMenu.cpp.

deactivate()

void game::state::PeoplemonMenu::deactivate ( bl::engine::Engine &  engine )

overridevirtual

Unsubscribes the menu to the engine event bus.

Implements game::state::State.

Definition at line 205 of file PeoplemonMenu.cpp.

name()

const char * game::state::PeoplemonMenu::name ( ) const

overridevirtual

Returns "PeoplemonMenu".

Implements game::state::State.

Definition at line 133 of file PeoplemonMenu.cpp.

update()

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

overridevirtual

Does nothing.

Implements game::state::State.

Definition at line 259 of file PeoplemonMenu.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:

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