OpenXcom  1.0
Open-source clone of the original X-Com
Public Member Functions | List of all members
OpenXcom::RuleCommendations Class Reference

Represents a specific type of commendation. More...

#include <RuleCommendations.h>

Public Member Functions

 RuleCommendations ()
 Creates a blank commendation ruleset. More...
 
 ~RuleCommendations ()
 Cleans up the commendation ruleset. More...
 
void load (const YAML::Node &node)
 Loads commendation data from YAML. More...
 
std::string getDescription () const
 Get the commendation's description. More...
 
std::map< std::string, std::vector< int > > * getCriteria ()
 Get the commendation's award criteria. More...
 
std::vector< std::vector< std::pair< int, std::vector< std::string > > > > * getKillCriteria ()
 Get the commendation's award kill related criteria. More...
 
int getSprite () const
 Get the commendation's sprite. More...
 

Detailed Description

Represents a specific type of commendation.

Contains constant info about a commendation like award criteria, sprite, description, etc.

See also
Commendation

Constructor & Destructor Documentation

◆ RuleCommendations()

OpenXcom::RuleCommendations::RuleCommendations ( )

Creates a blank commendation ruleset.

Creates a blank set of commendation data.

◆ ~RuleCommendations()

OpenXcom::RuleCommendations::~RuleCommendations ( )

Cleans up the commendation ruleset.

Cleans up the commendation.

Member Function Documentation

◆ getCriteria()

std::map< std::string, std::vector< int > > * OpenXcom::RuleCommendations::getCriteria ( )

Get the commendation's award criteria.

Returns
map<string, int> Commendation criteria.

◆ getDescription()

std::string OpenXcom::RuleCommendations::getDescription ( ) const

Get the commendation's description.

Returns
string Commendation description.

◆ getKillCriteria()

std::vector< std::vector< std::pair< int, std::vector< std::string > > > > * OpenXcom::RuleCommendations::getKillCriteria ( )

Get the commendation's award kill related criteria.

Get the commendation's award kill criteria.

Returns
vecotr<string> Commendation kill criteria.

◆ getSprite()

int OpenXcom::RuleCommendations::getSprite ( ) const

Get the commendation's sprite.

Returns
int Sprite number.

◆ load()

void OpenXcom::RuleCommendations::load ( const YAML::Node &  node)

Loads commendation data from YAML.

Loads the commendations from YAML.

Parameters
nodeYAML node.

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