OpenXcom::ResearchProject Class Reference

Represent a ResearchProject Contain information about assigned scientist, time already spent and cost of the project. More...

#include <ResearchProject.h>

Public Member Functions
bool	step ()
	Game logic. Called every new day to compute time spent. More...
bool	isFinished ()
	gets state of project.
void	setAssigned (int nb)
	set the number of scientist assigned to this ResearchProject More...
int	getAssigned () const
	get the number of scientist assigned to this ResearchProject More...
int	getSpent () const
	get time already spent on this ResearchProject More...
void	setSpent (int spent)
	set time already spent on this ResearchProject More...
int	getCost () const
	get time cost of this ResearchProject More...
void	setCost (int f)
	set time cost of this ResearchProject More...
const RuleResearch *	getRules () const
	get the ResearchProject Mod
void	load (const YAML::Node &node)
	load the ResearchProject from YAML More...
YAML::Node	save () const
	save the ResearchProject to YAML More...
std::string	getResearchProgress () const
	Get a string describing current progress. More...

Detailed Description

Represent a ResearchProject Contain information about assigned scientist, time already spent and cost of the project.

Member Function Documentation

getAssigned()

int OpenXcom::ResearchProject::getAssigned

(

)

const

get the number of scientist assigned to this ResearchProject

Returns the number of scientist assigned to this project.

Returns

Number of assigned scientist.

getCost()

int OpenXcom::ResearchProject::getCost

(

)

const

get time cost of this ResearchProject

Returns the cost of the ResearchProject.

Returns

the cost of the ResearchProject(in man/day)

getResearchProgress()

std::string OpenXcom::ResearchProject::getResearchProgress

(

)

const

Get a string describing current progress.

Return a string describing Research progress.

Returns

a string describing Research progress.

getSpent()

int OpenXcom::ResearchProject::getSpent

(

)

const

get time already spent on this ResearchProject

Returns the time already spent on this project.

Returns

the time already spent on this ResearchProject(in man/day)

load()

void OpenXcom::ResearchProject::load

(

const YAML::Node &

node

)

load the ResearchProject from YAML

Loads the research project from a YAML file.

Parameters

node	YAML node.

save()

YAML::Node OpenXcom::ResearchProject::save

(

)

const

save the ResearchProject to YAML

Saves the research project to a YAML file.

Returns

YAML node.

setAssigned()

void OpenXcom::ResearchProject::setAssigned

(

int

nb

)

set the number of scientist assigned to this ResearchProject

Changes the number of scientist to the ResearchProject.

Parameters

nb	number of scientist assigned to this ResearchProject

setCost()

void OpenXcom::ResearchProject::setCost

(

int

f

)

set time cost of this ResearchProject

Changes the cost of the ResearchProject.

Parameters

f	new project cost(in man/day)

setSpent()

void OpenXcom::ResearchProject::setSpent

(

int

spent

)

set time already spent on this ResearchProject

Changes the cost of the ResearchProject.

Parameters

spent

new project cost(in man/day)

step()

bool OpenXcom::ResearchProject::step

(

)

Game logic. Called every new day to compute time spent.

Called every day to compute time spent on this ResearchProject.

Returns

true if the ResearchProject is finished

---

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

• ResearchProject.h
• ResearchProject.cpp