game::state::BattleWrapperState Class Reference

Wrapper state that manages battle intro transitions as well as post-battle evolutions. More...

#include <BattleWrapperState.hpp>

Inheritance diagram for game::state::BattleWrapperState:

Public Member Functions
virtual	~BattleWrapperState ()=default
	Destroy the Battle Wrapper State. More...
const char *	name () const override
	Returns "BattleWrapperState". More...
virtual void	activate (bl::engine::Engine &engine) override
	Initiates the battle transition or evolution if applicable, otherwise pops this state. More...
virtual void	deactivate (bl::engine::Engine &engine) override
	Does nothing. More...
virtual void	update (bl::engine::Engine &engine, float dt, float) override
	Updates the intro sequence. More...

Static Public Member Functions
static bl::engine::State::Ptr	create (core::system::Systems &systems, std::unique_ptr< core::battle::Battle > &&battle)
	Creates a new BattleState. More...

Protected Attributes
core::system::Systems &	systems

Detailed Description

Wrapper state that manages battle intro transitions as well as post-battle evolutions.

Definition at line 26 of file BattleWrapperState.hpp.

Constructor & Destructor Documentation

~BattleWrapperState()

virtual game::state::BattleWrapperState::~BattleWrapperState ( )

virtualdefault

Destroy the Battle Wrapper State.

Member Function Documentation

activate()

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

overridevirtual

Initiates the battle transition or evolution if applicable, otherwise pops this state.

Parameters

engine

The game engine

Implements game::state::State.

Definition at line 39 of file BattleWrapperState.cpp.

create()

bl::engine::State::Ptr game::state::BattleWrapperState::create ( core::system::Systems &  systems, std::unique_ptr< core::battle::Battle > &&  battle  )

static

Creates a new BattleState.

Parameters

systems	The main game systems
battle	The battle to run. Must be fully initialized

Returns

bl::engine::State::Ptr The new game state

Definition at line 17 of file BattleWrapperState.cpp.

deactivate()

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

overridevirtual

Does nothing.

Parameters

engine

The game engine

Implements game::state::State.

Definition at line 66 of file BattleWrapperState.cpp.

name()

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

overridevirtual

Returns "BattleWrapperState".

Implements game::state::State.

Definition at line 37 of file BattleWrapperState.cpp.

update()

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

overridevirtual

Updates the intro sequence.

Parameters

engine	The game engine
dt	Time elapsed in seconds

Implements game::state::State.

Definition at line 70 of file BattleWrapperState.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/BattleWrapperState.hpp
• src/Game/States/BattleWrapperState.cpp