Peoplemon  0.1.0
Peoplemon 3 game source documentation
Public Member Functions | List of all members
core::map::weather::Snow Class Reference

Snow weather system. More...

#include <Snow.hpp>

+ Inheritance diagram for core::map::weather::Snow:

Public Member Functions

 Snow (bool hard, bool thunder)
 Create snowy weather. More...
 
virtual ~Snow ()
 Destroy the Snow object. More...
 
virtual Weather::Type type () const override
 One of LightSnow, LightSnowThunder, HardSnow, HardSnowThunder. More...
 
virtual void start (bl::engine::Engine &engine, bl::rc::RenderTarget &renderTarget, Map &map) override
 Start the snow. More...
 
virtual void stop () override
 Stops the snow. More...
 
virtual bool stopped () const override
 Returns true when no snow is left after a call to stop() More...
 
virtual void update (float dt) override
 Updates all the flakes and spawns more. More...
 

Detailed Description

Snow weather system.

Definition at line 28 of file Snow.hpp.

Constructor & Destructor Documentation

◆ Snow()

core::map::weather::Snow::Snow ( bool  hard,
bool  thunder 
)

Create snowy weather.

Parameters
hardTrue for hard snow, false for light
thunderTrue to enable thunder, false for no thunder

Definition at line 197 of file Snow.cpp.

◆ ~Snow()

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

Destroy the Snow object.

Definition at line 207 of file Snow.cpp.

Member Function Documentation

◆ start()

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

Start the snow.

Parameters
engineThe game engine instance
renderTargetThe render target the weather will be rendered to
mapThe map the weather is in

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

Definition at line 214 of file Snow.cpp.

◆ stop()

void core::map::weather::Snow::stop ( )
overridevirtual

Stops the snow.

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

Definition at line 235 of file Snow.cpp.

◆ stopped()

bool core::map::weather::Snow::stopped ( ) const
overridevirtual

Returns true when no snow is left after a call to stop()

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

Definition at line 240 of file Snow.cpp.

◆ type()

Weather::Type core::map::weather::Snow::type ( ) const
overridevirtual

One of LightSnow, LightSnowThunder, HardSnow, HardSnowThunder.

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

Definition at line 212 of file Snow.cpp.

◆ update()

void core::map::weather::Snow::update ( float  dt)
overridevirtual

Updates all the flakes and spawns more.

Parameters
dtTime elapsed in seconds since last call to update

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

Definition at line 242 of file Snow.cpp.


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