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::AlienRace Class Reference

Represents a specific race "family", or a "main race" if you wish. More...

#include <AlienRace.h>

Public Member Functions

 AlienRace (const std::string &id)
 Creates a blank alien race ruleset. More...
 
 ~AlienRace ()
 Cleans up the alien race ruleset.
 
void load (const YAML::Node &node)
 Loads alien race data from YAML. More...
 
std::string getId () const
 Gets the alien race's id. More...
 
std::string getMember (int id) const
 Gets a certain member of this alien race family. More...
 
bool canRetaliate () const
 Gets if the race can retaliate. More...
 

Detailed Description

Represents a specific race "family", or a "main race" if you wish.

Here is defined which ranks it contains and also which accompanying terror units.

Constructor & Destructor Documentation

OpenXcom::AlienRace::AlienRace ( const std::string &  id)

Creates a blank alien race ruleset.

Creates a blank alien race.

Parameters
idString defining the id.

Member Function Documentation

bool OpenXcom::AlienRace::canRetaliate ( ) const

Gets if the race can retaliate.

Returns if the race can participate in retaliation missions.

Returns
True if it can retaliate.
std::string OpenXcom::AlienRace::getId ( ) const

Gets the alien race's id.

Returns the language string that names this alien race.

Each race has a unique name.

Returns
Race name.
std::string OpenXcom::AlienRace::getMember ( int  id) const

Gets a certain member of this alien race family.

Parameters
idThe member's id.
Returns
The member's name.
void OpenXcom::AlienRace::load ( const YAML::Node &  node)

Loads alien race data from YAML.

Loads the alien race from a YAML file.

Parameters
nodeYAML node.

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