OpenXcom::AlienBase Class Reference

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

#include <AlienBase.h>

Inheritance diagram for OpenXcom::AlienBase:

Public Member Functions
	AlienBase ()
	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...
YAML::Node	saveId () const
	Saves the alien base's ID to YAML. More...
int	getId () const
	Gets the alien base's ID. More...
void	setId (int id)
	Sets the alien base's ID. More...
std::wstring	getName (Language *lang) const
	Gets the alien base's name. 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...
void	load (const YAML::Node &node)
	Loads the moving target from 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...
std::vector< Target * > *	getFollowers ()
	Gets the target's 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

OpenXcom::AlienBase::AlienBase

(

)

Creates an alien base.

Initializes an alien base.

Member Function Documentation

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.

int OpenXcom::AlienBase::getId

(

)

const

Gets the alien base's ID.

Returns the alien base's unique ID.

Returns

Unique ID.

std::wstring OpenXcom::AlienBase::getName ( Language *  lang ) const

virtual

Gets the alien base's name.

Returns the alien base's unique identifying name.

Parameters

lang	Language to get strings from.

Returns

Full name.

Implements OpenXcom::Target.

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?

bool OpenXcom::AlienBase::isInBattlescape

(

)

const

Gets the alien base's battlescape status.

Returns

Is the base on the battlescape?

void OpenXcom::AlienBase::load

(

const YAML::Node &

node

)

Loads the alien base from YAML.

Loads the alien base from a YAML file.

Parameters

node	YAML node.

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.

YAML::Node OpenXcom::AlienBase::saveId ( ) const

virtual

Saves the alien base's ID to YAML.

Saves the alien base's unique identifiers to a YAML file.

Returns

YAML node.

Reimplemented from OpenXcom::Target.

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

race	Alien race.

void OpenXcom::AlienBase::setDiscovered

(

bool

discovered

)

Sets the alien base's discovered status.

Sets the alien base's geoscape status.

Parameters

discovered

Has the base been discovered?

void OpenXcom::AlienBase::setId

(

int

id

)

Sets the alien base's ID.

Changes the alien base's unique ID.

Parameters

id	Unique ID.

void OpenXcom::AlienBase::setInBattlescape

(

bool

inbattle

)

Sets the alien base's battlescape status.

Parameters

inbattle

True if it's in battle, False otherwise.

---

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

• AlienBase.h
• AlienBase.cpp