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

Stores info about a soldier's death. More...

#include <SoldierDeath.h>

Public Member Functions

 SoldierDeath (GameTime time, BattleUnitKills *cause)
 Creates a death. More...
 
 ~SoldierDeath ()
 Cleans up the death. More...
 
void load (const YAML::Node &node)
 Loads the death from YAML. More...
 
YAML::Node save () const
 Saves the death to YAML. More...
 
const GameTimegetTime () const
 Gets the death time. More...
 
const BattleUnitKillsgetCause () const
 Gets the death cause. More...
 

Detailed Description

Stores info about a soldier's death.

Constructor & Destructor Documentation

◆ SoldierDeath()

OpenXcom::SoldierDeath::SoldierDeath ( GameTime  time,
BattleUnitKills cause 
)

Creates a death.

Initializes a death event.

◆ ~SoldierDeath()

OpenXcom::SoldierDeath::~SoldierDeath ( )

Cleans up the death.

Cleans up a death event.

Member Function Documentation

◆ getCause()

const BattleUnitKills * OpenXcom::SoldierDeath::getCause ( ) const

Gets the death cause.

Returns the time of death of this soldier.

Returns
Pointer to the time.

◆ getTime()

const GameTime * OpenXcom::SoldierDeath::getTime ( ) const

Gets the death time.

Returns the time of death of this soldier.

Returns
Pointer to the time.

◆ load()

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

Loads the death from YAML.

Loads the death from a YAML file.

Parameters
nodeYAML node.

◆ save()

YAML::Node OpenXcom::SoldierDeath::save ( ) const

Saves the death to YAML.

Saves the death to a YAML file.

Returns
YAML node.

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