upgrade.h File Reference

Go to the source code of this file.

upgrade.h - The upgrades headerfile.
#define	UPGRADE_MODIFIERS_MAX   (UpgradeMax * 4)
	How many upgrades modifiers supported. More...
CUpgradeModifier *	UpgradeModifiers [UPGRADE_MODIFIERS_MAX]
	The main user useable upgrades. More...
int	NumUpgradeModifiers
	Number of upgrades modifiers used. More...
void	InitUpgrades ()
	init upgrade/allow structures More...
void	SaveUpgrades (CFile &file)
	save the upgrades More...
void	CleanUpgrades ()
	cleanup upgrade module More...
void	UpgradesCclRegister ()
	Register CCL features for upgrades. More...
int	UnitTypeIdByIdent (const std::string &sid)
int	UpgradeIdByIdent (const std::string &sid)
void	UpgradeAcquire (CPlayer &player, const CUpgrade *upgrade)
	Upgrade will be acquired. More...
void	UpgradeLost (CPlayer &player, int id)
	Upgrade will be lost. More...
void	ApplyUpgrades ()
	Apply researched upgrades when map is loading. More...
void	ApplyIndividualUpgradeModifier (CUnit &unit, const CUpgradeModifier *um)
void	IndividualUpgradeAcquire (CUnit &unit, const CUpgrade *upgrade)
	Apply upgrade modifier of an individual upgrade. More...
void	IndividualUpgradeLost (CUnit &unit, const CUpgrade *upgrade)
	Make a unit acquire in individual upgrade. More...
int	UnitIdAllowed (const CPlayer &player, int id)
	Make a unit lose in individual upgrade. More...
void	AllowUpgradeId (CPlayer &player, int id, char af)
char	UpgradeIdAllowed (const CPlayer &player, int id)
char	UpgradeIdentAllowed (const CPlayer &player, const std::string &ident)

Macro Definition Documentation

UPGRADE_MODIFIERS_MAX

#define UPGRADE_MODIFIERS_MAX   (UpgradeMax * 4)

How many upgrades modifiers supported.

Function Documentation

AllowUpgradeId()

void AllowUpgradeId	(	CPlayer &	player,
		int	id,
		char	af
	)

Change allow for an upgrade.

Parameters

player	Player to change
id	upgrade id
af	A'llow/F'orbid/`R'eseached

ApplyIndividualUpgradeModifier()

void ApplyIndividualUpgradeModifier	(	CUnit &	unit,
		const CUpgradeModifier *	um
	)

Apply the modifiers of an individual upgrade.

Parameters

unit	Unit that will get the modifier applied
um	Upgrade modifier that does the effects

ApplyUpgrades()

void ApplyUpgrades

(

)

Apply researched upgrades when map is loading.

Apply researched upgrades when map is loading

Returns

: void

CleanUpgrades()

void CleanUpgrades

(

)

cleanup upgrade module

Cleanup the upgrade module.

IndividualUpgradeAcquire()

void IndividualUpgradeAcquire	(	CUnit &	unit,
		const CUpgrade *	upgrade
	)

Apply upgrade modifier of an individual upgrade.

IndividualUpgradeLost()

void IndividualUpgradeLost	(	CUnit &	unit,
		const CUpgrade *	upgrade
	)

Make a unit acquire in individual upgrade.

InitUpgrades()

void InitUpgrades

(

)

init upgrade/allow structures

Init upgrade/allow structures

SaveUpgrades()

void SaveUpgrades

(

CFile &

file

)

save the upgrades

Save state of the dependencies to file.

Parameters

file	Output file.

UnitIdAllowed()

int UnitIdAllowed	(	const CPlayer &	player,
		int	id
	)

Make a unit lose in individual upgrade.

Return the allow state of the unit.

Parameters

player	Check state of this player.
id	Unit identifier.

Returns

the allow state of the unit.

UnitTypeIdByIdent()

int UnitTypeIdByIdent

(

const std::string &

ident

)

UnitType ID by identifier.

Parameters

ident

The unit-type identifier.

Returns

Unit-type ID (int) or -1 if not found.

UpgradeAcquire()

void UpgradeAcquire	(	CPlayer &	player,
		const CUpgrade *	upgrade
	)

Upgrade will be acquired.

Handle that an upgrade was acquired.

Parameters

player	Player researching the upgrade.
upgrade	Upgrade ready researched.

UpgradeIdAllowed()

char UpgradeIdAllowed	(	const CPlayer &	player,
		int	id
	)

Return the allow state of an upgrade.

Parameters

player	Check state for this player.
id	Upgrade identifier.

Returns

the allow state of the upgrade.

UpgradeIdByIdent()

int UpgradeIdByIdent

(

const std::string &

ident

)

Upgrade ID by identifier.

Parameters

ident

The upgrade identifier.

Returns

Upgrade ID (int) or -1 if not found.

UpgradeIdentAllowed()

char UpgradeIdentAllowed	(	const CPlayer &	player,
		const std::string &	ident
	)

Return the allow state of an upgrade.

Parameters

player	Check state for this player.
ident	Upgrade identifier.

Note

This function shouldn't be used during runtime, it is only for setup.

UpgradeLost()

void UpgradeLost	(	CPlayer &	player,
		int	id
	)

Upgrade will be lost.

Upgrade will be lost

Parameters

player	Player researching the upgrade.
id	Upgrade to be lost.

UpgradesCclRegister()

void UpgradesCclRegister

(

)

Register CCL features for upgrades.

Register CCL features for upgrades.

Variable Documentation

NumUpgradeModifiers

int NumUpgradeModifiers

Number of upgrades modifiers used.

UpgradeModifiers

CUpgradeModifier* UpgradeModifiers[UPGRADE_MODIFIERS_MAX]

The main user useable upgrades.

Upgrades modifiers