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...

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

AlienRace()

OpenXcom::AlienRace::AlienRace

(

const std::string &

id

)

Creates a blank alien race ruleset.

Creates a blank alien race.

Parameters

id	String defining the id.

Member Function Documentation

getId()

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.

getMember()

std::string OpenXcom::AlienRace::getMember

(

int

id

)

const

Gets a certain member of this alien race family.

Parameters

id	The member's id.

Returns

The member's name.

load()

void OpenXcom::AlienRace::load

(

const YAML::Node &

node

)

Loads alien race data from YAML.

Loads the alien race from a YAML file.

Parameters

node	YAML node.

---

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

• AlienRace.h
• AlienRace.cpp