OpenXcom::AlienDeployment Class Reference

Represents a specific type of Alien Deployment. More...

#include <AlienDeployment.h>

Public Member Functions
	AlienDeployment (const std::string &type)
	Creates a blank Alien Deployment ruleset. More...
	~AlienDeployment ()
	Cleans up the Alien Deployment ruleset.
void	load (const YAML::Node &node)
	Loads Alien Deployment data from YAML. More...
std::string	getType () const
	Gets the Alien Deployment's type. More...
std::vector< DeploymentData > *	getDeploymentData ()
	Gets a pointer to the data. More...
void	getDimensions (int *width, int *length, int *height)
	Gets dimensions. More...
int	getCivilians () const
	Gets civilians. More...
std::vector< std::string >	getTerrains () const
	Gets the terrain for battlescape generation. More...
int	getShade () const
	Gets the shade level for battlescape generation. More...
std::string	getNextStage () const
	Gets the next stage of the mission. More...

Detailed Description

Represents a specific type of Alien Deployment.

Contains constant info about a Alien Deployment like the number of aliens for each alien type and what items they carry (itemset depends on alien technology advancement level 0, 1 or 2).

• deployment type can be a craft's name, but also alien base or cydonia.
• alienRank is used to check which nodeRanks can be used to deploy this unit
  • to match to a specific unit (=race/rank combination) that should be deployed.

    See Also

    Node

Constructor & Destructor Documentation

OpenXcom::AlienDeployment::AlienDeployment

(

const std::string &

type

)

Creates a blank Alien Deployment ruleset.

Creates a blank ruleset for a certain type of deployment data.

Parameters

type	String defining the type.

Member Function Documentation

int OpenXcom::AlienDeployment::getCivilians

(

)

const

Gets civilians.

Gets the number of civilians.

Returns

The number of civilians.

std::vector< DeploymentData > * OpenXcom::AlienDeployment::getDeploymentData

(

)

Gets a pointer to the data.

Returns

Pointer to the data.

void OpenXcom::AlienDeployment::getDimensions	(	int *	width,
		int *	length,
		int *	height
	)

Gets dimensions.

Parameters

width	Width.
length	Length.
height	Height.

std::string OpenXcom::AlienDeployment::getNextStage

(

)

const

Gets the next stage of the mission.

Returns

The next stage of the mission.

int OpenXcom::AlienDeployment::getShade

(

)

const

Gets the shade level for battlescape generation.

Returns

The shade level.

std::vector< std::string > OpenXcom::AlienDeployment::getTerrains

(

)

const

Gets the terrain for battlescape generation.

Returns

The terrain.

std::string OpenXcom::AlienDeployment::getType

(

)

const

Gets the Alien Deployment's type.

Returns the language string that names this deployment.

Each deployment type has a unique name.

Returns

Deployment name.

void OpenXcom::AlienDeployment::load

(

const YAML::Node &

node

)

Loads Alien Deployment data from YAML.

Loads the Deployment from a YAML file.

Parameters

node	YAML node.

---

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

• AlienDeployment.h
• AlienDeployment.cpp