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

Creates sandstorms. More...

#include <Sandstorm.hpp>

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

Public Member Functions

 Sandstorm ()
 Creates the sandstorm. More...
 
virtual ~Sandstorm ()
 Destroy the Sandstorm object. More...
 
virtual Weather::Type type () const override
 Returns Sandstorm. More...
 
virtual void start (bl::engine::Engine &engine, bl::rc::RenderTarget &renderTarget, Map &map) override
 Starts the sandstorm. More...
 
virtual void stop () override
 Stops the sandstorm. More...
 
virtual bool stopped () const override
 Returns true if the sandstorm is fully stopped, false if stopping. More...
 
virtual void update (float dt) override
 Updates the sandstorm. More...
 

Detailed Description

Creates sandstorms.

Definition at line 26 of file Sandstorm.hpp.

Constructor & Destructor Documentation

◆ Sandstorm()

core::map::weather::Sandstorm::Sandstorm ( )

Creates the sandstorm.

Definition at line 333 of file Sandstorm.cpp.

◆ ~Sandstorm()

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

Destroy the Sandstorm object.

Definition at line 337 of file Sandstorm.cpp.

Member Function Documentation

◆ start()

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

Starts the sandstorm.

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 350 of file Sandstorm.cpp.

◆ stop()

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

Stops the sandstorm.

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

Definition at line 346 of file Sandstorm.cpp.

◆ stopped()

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

Returns true if the sandstorm is fully stopped, false if stopping.

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

Definition at line 348 of file Sandstorm.cpp.

◆ type()

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

Returns Sandstorm.

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

Definition at line 344 of file Sandstorm.cpp.

◆ update()

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

Updates the sandstorm.

Parameters
dtTime elapsed in seconds since the last call to update

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

Definition at line 390 of file Sandstorm.cpp.


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