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

Represents an alien base on the world. More...

#include <AlienBase.h>

Inheritance diagram for OpenXcom::AlienBase:
OpenXcom::Target

Public Member Functions

 AlienBase (AlienDeployment *deployment)
 Creates an alien base. More...
 
 ~AlienBase ()
 Cleans up the alien base.
 
void load (const YAML::Node &node)
 Loads the alien base from YAML. More...
 
YAML::Node save () const
 Saves the alien base to YAML. More...
 
std::string getType () const
 Gets the alien base's type. More...
 
int getMarker () const
 Gets the alien base's marker sprite. More...
 
std::string getAlienRace () const
 Gets the alien base's amount of active hours. More...
 
void setAlienRace (const std::string &race)
 Sets the alien base's alien race. More...
 
void setInBattlescape (bool inbattle)
 Sets the alien base's battlescape status. More...
 
bool isInBattlescape () const
 Gets the alien base's battlescape status. More...
 
bool isDiscovered () const
 Gets the alien base's discovered status. More...
 
void setDiscovered (bool discovered)
 Sets the alien base's discovered status. More...
 
- Public Member Functions inherited from OpenXcom::Target
virtual ~Target ()
 Cleans up the target. 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 an alien base on the world.

Constructor & Destructor Documentation

◆ AlienBase()

OpenXcom::AlienBase::AlienBase ( AlienDeployment deployment)

Creates an alien base.

Initializes an alien base.

Member Function Documentation

◆ getAlienRace()

std::string OpenXcom::AlienBase::getAlienRace ( ) const

Gets the alien base's amount of active hours.

Returns the alien race currently residing in the alien base.

Returns
Alien race.

◆ getMarker()

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

Gets the alien base's marker sprite.

Returns the globe marker for the alien base.

Returns
Marker sprite, -1 if none.

Implements OpenXcom::Target.

◆ getType()

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

Gets the alien base's type.

Returns the alien base's unique type used for savegame purposes.

Returns
ID.

Implements OpenXcom::Target.

◆ isDiscovered()

bool OpenXcom::AlienBase::isDiscovered ( ) const

Gets the alien base's discovered status.

Gets the alien base's geoscape status.

Returns
Has the base been discovered?

◆ isInBattlescape()

bool OpenXcom::AlienBase::isInBattlescape ( ) const

Gets the alien base's battlescape status.

Returns
Is the base on the battlescape?

◆ load()

void OpenXcom::AlienBase::load ( const YAML::Node &  node)
virtual

Loads the alien base from YAML.

Loads the alien base from a YAML file.

Parameters
nodeYAML node.

Reimplemented from OpenXcom::Target.

◆ save()

YAML::Node OpenXcom::AlienBase::save ( ) const
virtual

Saves the alien base to YAML.

Saves the alien base to a YAML file.

Returns
YAML node.

Reimplemented from OpenXcom::Target.

◆ setAlienRace()

void OpenXcom::AlienBase::setAlienRace ( const std::string &  race)

Sets the alien base's alien race.

Changes the alien race currently residing in the alien base.

Parameters
raceAlien race.

◆ setDiscovered()

void OpenXcom::AlienBase::setDiscovered ( bool  discovered)

Sets the alien base's discovered status.

Sets the alien base's geoscape status.

Parameters
discoveredHas the base been discovered?

◆ setInBattlescape()

void OpenXcom::AlienBase::setInBattlescape ( bool  inbattle)

Sets the alien base's battlescape status.

Parameters
inbattleTrue if it's in battle, False otherwise.

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