core::map::weather::Base Struct Reference

Base class for all weather types. More...

#include <Base.hpp>

Inheritance diagram for core::map::weather::Base:

Public Member Functions
virtual	~Base ()=default
	Destroy the Base object. More...
virtual Weather::Type	type () const =0
	Returns the type of weather this is. More...
virtual void	update (float dt)=0
	Update the weather. More...
virtual void	start (bl::engine::Engine &engine, bl::rc::RenderTarget &renderTarget, Map &map)=0
	Start the weather using the initial area. More...
virtual void	stop ()=0
	Stop the weather. More...
virtual bool	stopped () const =0
	Returns true when the weather has completed stopping. More...

Detailed Description

Base class for all weather types.

Definition at line 28 of file Base.hpp.

Constructor & Destructor Documentation

~Base()

virtual core::map::weather::Base::~Base ( )

virtualdefault

Destroy the Base object.

Member Function Documentation

start()

virtual void core::map::weather::Base::start ( bl::engine::Engine &  engine, bl::rc::RenderTarget &  renderTarget, Map &  map  )

pure virtual

Start the weather using the initial area.

Parameters

engine	The game engine instance
renderTarget	The render target the weather will be rendered to
map	The map the weather is in

Implemented in core::map::weather::Sunny, core::map::weather::Snow, core::map::weather::Sandstorm, core::map::weather::Rain, and core::map::weather::Fog.

stop()

virtual void core::map::weather::Base::stop ( )

pure virtual

Stop the weather.

Implemented in core::map::weather::Sunny, core::map::weather::Snow, core::map::weather::Sandstorm, core::map::weather::Rain, and core::map::weather::Fog.

stopped()

virtual bool core::map::weather::Base::stopped ( ) const

pure virtual

Returns true when the weather has completed stopping.

Returns

True if no particles remain, false if not finished stopping

Implemented in core::map::weather::Sunny, core::map::weather::Snow, core::map::weather::Sandstorm, core::map::weather::Rain, and core::map::weather::Fog.

type()

virtual Weather::Type core::map::weather::Base::type ( ) const

pure virtual

Returns the type of weather this is.

Returns

Weather::Type The type of weather this is

Implemented in core::map::weather::Sunny, core::map::weather::Snow, core::map::weather::Sandstorm, core::map::weather::Rain, and core::map::weather::Fog.

update()

virtual void core::map::weather::Base::update ( float  dt )

pure virtual

Update the weather.

Parameters

dt	Time elapsed in seconds since last call to update

Implemented in core::map::weather::Sunny, core::map::weather::Snow, core::map::weather::Sandstorm, core::map::weather::Rain, and core::map::weather::Fog.

---

The documentation for this struct was generated from the following file:

• src/Core/Maps/Weather/Base.hpp