Alien containment class. More...

#include <aliencontainment.h>

Inheritance diagram for AlienContainment:

Collaboration diagram for AlienContainment:

Public Member Functions
virtual bool	add (const teamDef_t *team, int alive, int dead)
	Add aliens to the containment by teamDef.
virtual bool	add (const char *teamId, int alive, int dead)
	Add aliens to the containment by scripted team ID.
	AlienContainment (capacities_t aliveCapacity, capacities_t deadCapacity)
	Creates and initializes AlienContainment object.
virtual	~AlienContainment (void)
	Destroys AlienContainer with it's internal data.
Public Member Functions inherited from AlienCargo
int	getAlive (const teamDef_t *team) const
	Return number of alive aliens of a type in the cargo.
int	getDead (const teamDef_t *team) const
	Return number of dead alien bodies of a type in the cargo.
int	getAlive (void) const
	Return number of all alive aliens in the cargo.
int	getDead (void) const
	Return number of all dead bodies in the cargo.
linkedList_t *	list (void) const
	Returns a copy of the cargo list.
bool	load (xmlNode_t *root)
	Load alien cargo from xml savegame.
bool	save (xmlNode_t *root) const
	Save alien cargo to xml savegame.
	AlienCargo (void)
	Creates and initializes AlienCargo object.
	AlienCargo (AlienCargo &alienCargo)
	Creates and initializes AlienCargo object from another one.
virtual	~AlienCargo (void)
	Destroys AlienCargo with it's internal data.

Static Public Member Functions
static bool	isLifeSupported (const teamDef_t *team)
	Returns if storing a specific life form is supported by the containment.
static int	getCapacityNeedForAlien (const teamDef_t *teamDef, const bool isDead)
	Returns the number of capacity needed for an alien in the containment.

Protected Attributes
capacities_t *	aliveCapacity
capacities_t *	deadCapacity
Protected Attributes inherited from AlienCargo
linkedList_t *	cargo
int	sumAlive
int	sumDead

Private Member Functions
void	resetCurrentCapacities (void)
	Private metod to reset current capacities.

Detailed Description

Alien containment class.

Definition at line 33 of file aliencontainment.h.

Constructor & Destructor Documentation

◆ AlienContainment()

AlienContainment::AlienContainment	(	capacities_t *	aliveCapacity,
		capacities_t *	deadCapacity )

Creates and initializes AlienContainment object.

Definition at line 129 of file aliencontainment.cpp.

References aliveCapacity, deadCapacity, and resetCurrentCapacities().

◆ ~AlienContainment()

AlienContainment::~AlienContainment ( void )

virtual

Destroys AlienContainer with it's internal data.

Definition at line 137 of file aliencontainment.cpp.

References resetCurrentCapacities().

Member Function Documentation

◆ add() [1/2]

bool AlienContainment::add	(	const char *	teamId,
		int	alive,
		int	dead )

virtual

Add aliens to the containment by scripted team ID.

Parameters

[in]	teamId	Scripted team ID string
[in]	alive	Number of alive aliens
[in]	dead	Number of dead aliens

Reimplemented from AlienCargo.

Definition at line 116 of file aliencontainment.cpp.

References add(), and cgi.

◆ add() [2/2]

bool AlienContainment::add	(	const teamDef_t *	team,
		int	alive,
		int	dead )

virtual

Add aliens to the containment by teamDef.

Parameters

[in]	team	Pointer to the alien Team Definition
[in]	alive	Number of alive aliens
[in]	dead	Number of dead aliens

Reimplemented from AlienCargo.

Definition at line 86 of file aliencontainment.cpp.

References AlienCargo::add(), aliveCapacity, deadCapacity, AlienCargo::getAlive(), getCapacityNeedForAlien(), AlienCargo::getDead(), isLifeSupported(), RS_GetTechForTeam(), and RS_MarkCollected().

Referenced by AC_KillAll_f(), AC_KillExceeding_f(), AC_KillOne_f(), AC_LoadXML(), add(), AL_AddAliens(), TR_EmptyTransferCargo(), and TR_TransferStart().

◆ getCapacityNeedForAlien()

int AlienContainment::getCapacityNeedForAlien	(	const teamDef_t *	teamDef,
		const bool	isDead )

static

Returns the number of capacity needed for an alien in the containment.

Parameters

[in]	teamDef	Pointer to the alien Team Definition
[in]	isDead	If the alien to calculate for is dead

Definition at line 37 of file aliencontainment.cpp.

Referenced by AC_KillExceeding_f(), and add().

◆ isLifeSupported()

bool AlienContainment::isLifeSupported ( const teamDef_t * team )

static

Returns if storing a specific life form is supported by the containment.

Parameters

[in] team Pointer to the alien Team Definition

Todo: find a way that doesn't need a tech ID hardcoded

Definition at line 57 of file aliencontainment.cpp.

References BREATHINGAPPARATUS_TECH, CHRSH_IsTeamDefAlien(), CHRSH_IsTeamDefRobot(), RS_GetTechByID(), and RS_IsResearched_ptr().

Referenced by add(), and AL_AddAliens().

◆ resetCurrentCapacities()

void AlienContainment::resetCurrentCapacities ( void )

private

Private metod to reset current capacities.

Definition at line 45 of file aliencontainment.cpp.

References aliveCapacity, and deadCapacity.

Referenced by AlienContainment(), and ~AlienContainment().

Field Documentation

◆ aliveCapacity

capacities_t* AlienContainment::aliveCapacity

protected

Definition at line 35 of file aliencontainment.h.

Referenced by add(), AlienContainment(), and resetCurrentCapacities().

◆ deadCapacity

capacities_t* AlienContainment::deadCapacity

protected

Definition at line 36 of file aliencontainment.h.

Referenced by add(), AlienContainment(), and resetCurrentCapacities().

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

src/client/cgame/campaign/aliencontainment.h
src/client/cgame/campaign/aliencontainment.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AlienContainment()

◆ ~AlienContainment()

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ getCapacityNeedForAlien()

◆ isLifeSupported()

◆ resetCurrentCapacities()

Field Documentation

◆ aliveCapacity

◆ deadCapacity