Peoplemon  0.1.0
Peoplemon 3 game source documentation
Classes | Public Member Functions | List of all members
core::system::Flight Class Reference

Special system to manage player flight between their current location and a town. More...

#include <Flight.hpp>

+ Inheritance diagram for core::system::Flight:

Public Member Functions

 Flight (Systems &systems)
 Construct a new Flight system. More...
 
virtual ~Flight ()=default
 Destroys the system. More...
 
bool flying () const
 Returns whether or not the player is currently flying. More...
 
bool startFlight (unsigned int destSpawn)
 Starts flight to the given spawn. More...
 

Detailed Description

Special system to manage player flight between their current location and a town.

Definition at line 21 of file Flight.hpp.

Constructor & Destructor Documentation

◆ Flight()

core::system::Flight::Flight ( Systems systems)

Construct a new Flight system.

Parameters
systemsThe main game systems

Definition at line 39 of file Flight.cpp.

◆ ~Flight()

virtual core::system::Flight::~Flight ( )
virtualdefault

Destroys the system.

Member Function Documentation

◆ flying()

bool core::system::Flight::flying ( ) const

Returns whether or not the player is currently flying.

Definition at line 48 of file Flight.cpp.

◆ startFlight()

bool core::system::Flight::startFlight ( unsigned int  destSpawn)

Starts flight to the given spawn.

Parameters
destSpawnThe spawn to fly to
Returns
True if flight could start, false on error

Definition at line 50 of file Flight.cpp.

Member Data Documentation

◆ flyState

FlyState core::system::Flight::flyState

Definition at line 96 of file Flight.hpp.

◆ holdState

HoldState core::system::Flight::holdState

Definition at line 97 of file Flight.hpp.

◆ riseState

RiseState core::system::Flight::riseState

Definition at line 94 of file Flight.hpp.

◆ rotateState

RotateState core::system::Flight::rotateState

Definition at line 95 of file Flight.hpp.


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