OpenXcom::Region Class Reference

Represents a region of the world. More...

#include <Region.h>

Public Member Functions
	Region (RuleRegion *rules)
	Creates a new region of the specified type. More...
	~Region ()
	Cleans up the region.
void	load (const YAML::Node &node)
	Loads the region from YAML. More...
YAML::Node	save () const
	Saves the region to YAML. More...
RuleRegion *	getRules () const
	Gets the region's ruleset. More...
void	addActivityXcom (int activity)
	add xcom activity in this region More...
void	addActivityAlien (int activity)
	add alien activity in this region More...
std::vector< int > &	getActivityXcom ()
	get xcom activity to this region More...
std::vector< int > &	getActivityAlien ()
	get xcom activity to this region More...
void	newMonth ()
	start new month of activity More...

Detailed Description

Represents a region of the world.

Contains variable info about a region like X-Com and alien activity in it.

Constructor & Destructor Documentation

Region()

OpenXcom::Region::Region

(

RuleRegion *

rules

)

Creates a new region of the specified type.

Initializes a region of the specified type.

Parameters

rules

Pointer to ruleset.

Member Function Documentation

addActivityAlien()

void OpenXcom::Region::addActivityAlien

(

int

activity

)

add alien activity in this region

Adds to the region's alien activity level.

Parameters

activity

Amount to add.

addActivityXcom()

void OpenXcom::Region::addActivityXcom

(

int

activity

)

add xcom activity in this region

Adds to the region's xcom activity level.

Parameters

activity

Amount to add.

getActivityAlien()

std::vector< int > & OpenXcom::Region::getActivityAlien

(

)

get xcom activity to this region

Gets the region's alien activity level.

Returns

activity level.

getActivityXcom()

std::vector< int > & OpenXcom::Region::getActivityXcom

(

)

get xcom activity to this region

Gets the region's xcom activity level.

Returns

activity level.

getRules()

RuleRegion * OpenXcom::Region::getRules

(

)

const

Gets the region's ruleset.

Returns the ruleset for the region's type.

Returns

Pointer to ruleset.

load()

void OpenXcom::Region::load

(

const YAML::Node &

node

)

Loads the region from YAML.

Loads the region from a YAML file.

Parameters

node	YAML node.

newMonth()

void OpenXcom::Region::newMonth

(

)

start new month of activity

Store last month's counters, start new counters.

save()

YAML::Node OpenXcom::Region::save

(

)

const

Saves the region to YAML.

Saves the region to a YAML file.

Returns

YAML node.

---

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

• Region.h
• Region.cpp