core::map::weather::Fog Class Reference

Weather type for thin or thick fog. More...

#include <Fog.hpp>

Inheritance diagram for core::map::weather::Fog:

Public Member Functions
	Fog (bool thick)
	Creates foggy weather. More...
virtual	~Fog ()
	No more fog. More...
virtual Weather::Type	type () const override
	Returns ThinFog or ThickFog. More...
virtual void	start (bl::engine::Engine &engine, bl::rc::RenderTarget &renderTarget, Map &map) override
	Starts the fog. More...
virtual void	stop () override
	Stops the fog. More...
virtual bool	stopped () const override
	Returns true when the fog is fully dissipated, false if not. More...
virtual void	update (float dt) override
	Updates the fog. More...

Detailed Description

Weather type for thin or thick fog.

Definition at line 25 of file Fog.hpp.

Constructor & Destructor Documentation

Fog()

core::map::weather::Fog::Fog

(

bool

thick

)

Creates foggy weather.

Parameters

thick

True for thick fog, false for thin fog

Definition at line 237 of file Fog.cpp.

~Fog()

core::map::weather::Fog::~Fog ( )

virtual

No more fog.

Definition at line 244 of file Fog.cpp.

Member Function Documentation

start()

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

overridevirtual

Starts the fog.

Parameters

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

Implements core::map::weather::Base.

Definition at line 252 of file Fog.cpp.

stop()

void core::map::weather::Fog::stop ( )

overridevirtual

Stops the fog.

Implements core::map::weather::Base.

Definition at line 275 of file Fog.cpp.

stopped()

bool core::map::weather::Fog::stopped ( ) const

overridevirtual

Returns true when the fog is fully dissipated, false if not.

Implements core::map::weather::Base.

Definition at line 277 of file Fog.cpp.

type()

Weather::Type core::map::weather::Fog::type ( ) const

overridevirtual

Returns ThinFog or ThickFog.

Implements core::map::weather::Base.

Definition at line 248 of file Fog.cpp.

update()

void core::map::weather::Fog::update ( float  dt )

overridevirtual

Updates the fog.

Parameters

dt	Time elapsed in seconds since last call to update

Implements core::map::weather::Base.

Definition at line 281 of file Fog.cpp.

---

The documentation for this class was generated from the following files:

• src/Core/Maps/Weather/Fog.hpp
• src/Core/Maps/Weather/Fog.cpp