OpenXcom  1.0
Open-source clone of the original X-Com
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
OpenXcom::TerrorSite Class Reference

Represents an alien terror site on the world. More...

#include <TerrorSite.h>

Inheritance diagram for OpenXcom::TerrorSite:
OpenXcom::Target

Public Member Functions

 TerrorSite ()
 Creates a terror site. More...
 
 ~TerrorSite ()
 Cleans up the terror site.
 
void load (const YAML::Node &node)
 Loads the terror site from YAML. More...
 
YAML::Node save () const
 Saves the terror site to YAML. More...
 
YAML::Node saveId () const
 Saves the terror site's ID to YAML. More...
 
int getId () const
 Gets the terror site's ID. More...
 
void setId (int id)
 Sets the terror site's ID. More...
 
std::wstring getName (Language *lang) const
 Gets the terror site's name. More...
 
size_t getSecondsRemaining () const
 Gets the seconds until this terror site expires. More...
 
void setSecondsRemaining (size_t seconds)
 Sets the seconds until this terror site expires. More...
 
std::string getAlienRace () const
 Gets the terror site's alien race. More...
 
void setAlienRace (const std::string &race)
 Sets the terror site's alien race. More...
 
void setInBattlescape (bool inbattle)
 Sets the TerrorSite's battlescape status. More...
 
bool isInBattlescape () const
 Gets if the TerrorSite is in battlescape. 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 terror site on the world.

Constructor & Destructor Documentation

OpenXcom::TerrorSite::TerrorSite ( )

Creates a terror site.

Initializes a terror site.

Member Function Documentation

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

Gets the terror site's alien race.

Returns the alien race currently residing in the terror site.

Returns
Alien race.
int OpenXcom::TerrorSite::getId ( ) const

Gets the terror site's ID.

Returns the terror site's unique ID.

Returns
Unique ID.
std::wstring OpenXcom::TerrorSite::getName ( Language lang) const
virtual

Gets the terror site's name.

Returns the terror site's unique identifying name.

Parameters
langLanguage to get strings from.
Returns
Full name.

Implements OpenXcom::Target.

size_t OpenXcom::TerrorSite::getSecondsRemaining ( ) const

Gets the seconds until this terror site expires.

Returns the number of seconds remaining before the terror site expires.

Returns
Amount of seconds.
bool OpenXcom::TerrorSite::isInBattlescape ( ) const

Gets if the TerrorSite is in battlescape.

Gets the terror site's battlescape status.

Returns
bool
void OpenXcom::TerrorSite::load ( const YAML::Node &  node)

Loads the terror site from YAML.

Loads the terror site from a YAML file.

Parameters
nodeYAML node.
YAML::Node OpenXcom::TerrorSite::save ( ) const
virtual

Saves the terror site to YAML.

Saves the terror site to a YAML file.

Returns
YAML node.

Reimplemented from OpenXcom::Target.

YAML::Node OpenXcom::TerrorSite::saveId ( ) const
virtual

Saves the terror site's ID to YAML.

Saves the terror site's unique identifiers to a YAML file.

Returns
YAML node.

Reimplemented from OpenXcom::Target.

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

Sets the terror site's alien race.

Changes the alien race currently residing in the terror site.

Parameters
raceAlien race.
void OpenXcom::TerrorSite::setId ( int  id)

Sets the terror site's ID.

Changes the terror site's unique ID.

Parameters
idUnique ID.
void OpenXcom::TerrorSite::setInBattlescape ( bool  inbattle)

Sets the TerrorSite's battlescape status.

Sets the terror site's battlescape status.

Parameters
inbattle.
void OpenXcom::TerrorSite::setSecondsRemaining ( size_t  seconds)

Sets the seconds until this terror site expires.

Changes the number of seconds before the terror site expires.

Parameters
secondsAmount of seconds.

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