OpenXcom  1.0
Open-source clone of the original X-Com
Public Member Functions | List of all members
OpenXcom::Waypoint Class Reference

Represents a fixed waypoint on the world. More...

#include <Waypoint.h>

Inheritance diagram for OpenXcom::Waypoint:
OpenXcom::Target

Public Member Functions

 Waypoint ()
 Creates a waypoint. More...
 
 ~Waypoint ()
 Cleans up the waypoint.
 
std::string getType () const
 Gets the waypoint's type. More...
 
int getMarker () const
 Gets the waypoint's marker sprite. More...
 
- Public Member Functions inherited from OpenXcom::Target
virtual ~Target ()
 Cleans up the target. More...
 
virtual void load (const YAML::Node &node)
 Loads the target from YAML. More...
 
virtual YAML::Node save () const
 Saves the target to YAML. More...
 
YAML::Node saveId () const
 Saves the target's ID to YAML. More...
 
double getLongitude () const
 Gets the target's longitude. More...
 
void setLongitude (double lon)
 Sets the target's longitude. More...
 
double getLatitude () const
 Gets the target's latitude. More...
 
void setLatitude (double lat)
 Sets the target's latitude. More...
 
int getId () const
 Gets the target's ID. More...
 
void setId (int id)
 Sets the target's ID. More...
 
virtual std::string getName (Language *lang) const
 Gets the target's name. More...
 
void setName (const std::string &newName)
 Sets the target's name. More...
 
virtual std::string getDefaultName (Language *lang) const
 Gets the target's default name. More...
 
virtual std::string getMarkerName () const
 Gets the target's marker name. More...
 
std::vector< MovingTarget * > * getFollowers ()
 Gets the target's followers. More...
 
std::vector< Craft * > getCraftFollowers () const
 Gets the target's craft followers. More...
 
double getDistance (const Target *target) const
 Gets the distance to another target. More...
 

Additional Inherited Members

- Protected Member Functions inherited from OpenXcom::Target
 Target ()
 Creates a target. More...
 

Detailed Description

Represents a fixed waypoint on the world.

Constructor & Destructor Documentation

◆ Waypoint()

OpenXcom::Waypoint::Waypoint ( )

Creates a waypoint.

Initializes a waypoint.

Member Function Documentation

◆ getMarker()

int OpenXcom::Waypoint::getMarker ( ) const
virtual

Gets the waypoint's marker sprite.

Returns the globe marker for the waypoint.

Returns
Marker sprite, -1 if none.

Implements OpenXcom::Target.

◆ getType()

std::string OpenXcom::Waypoint::getType ( ) const
virtual

Gets the waypoint's type.

Returns the waypoint's unique type used for savegame purposes.

Returns
ID.

Implements OpenXcom::Target.


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