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

Debug only state that allows free roaming the map with a special camera. More...

#include <MapExplorer.hpp>

+ Inheritance diagram for game::state::MapExplorer:

Public Member Functions

virtual ~MapExplorer ()=default
 Destroy the Map Explorer state. More...
 
virtual const char * name () const override
 Returns "MapExplorer". More...
 
virtual void activate (bl::engine::Engine &engine) override
 Activates the state and camera. Disconnects the player from their entity. More...
 
virtual void deactivate (bl::engine::Engine &engine) override
 Reconnects the player to their entity and pops the camera. More...
 
virtual void update (bl::engine::Engine &engine, float dt, float) override
 Updates the game world logic and the hint fadeout. More...
 

Static Public Member Functions

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

Protected Attributes

core::system::Systemssystems
 

Detailed Description

Debug only state that allows free roaming the map with a special camera.

Definition at line 18 of file MapExplorer.hpp.

Constructor & Destructor Documentation

◆ ~MapExplorer()

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

Destroy the Map Explorer state.

Member Function Documentation

◆ activate()

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

Activates the state and camera. Disconnects the player from their entity.

Parameters
engineThe game engine

Implements game::state::State.

Definition at line 78 of file MapExplorer.cpp.

◆ create()

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

Creates a new MapExplorer state.

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

Definition at line 54 of file MapExplorer.cpp.

◆ deactivate()

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

Reconnects the player to their entity and pops the camera.

Parameters
engineThe game engine

Implements game::state::State.

Definition at line 92 of file MapExplorer.cpp.

◆ name()

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

Returns "MapExplorer".

Implements game::state::State.

Definition at line 76 of file MapExplorer.cpp.

◆ update()

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

Updates the game world logic and the hint fadeout.

Parameters
engineThe game engine
dtTime elapsed in seconds

Implements game::state::State.

Definition at line 99 of file MapExplorer.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: