Header for installation management related stuff. More...

This graph shows which files directly or indirectly include this file:

Data Structures
struct	installationTemplate_t
struct	installation_t
	A installation with all it's data. More...

Macros
#define	MAX_INSTALLATIONS_PER_BASE 3
#define	MAX_INSTALLATION_TEMPLATES 6
#define	MAX_INSTALLATION_DAMAGE 100
#define	MAX_INSTALLATION_BATTERIES 5
#define	INS_Foreach(var)
#define	INS_ForeachOfType(var, installationType)
#define	INS_GetInstallationIDX(installation)

Enumerations
enum	installationStatus_t { INSTALLATION_NOT_USED , INSTALLATION_UNDER_CONSTRUCTION , INSTALLATION_WORKING }
	Possible installation states. More...
enum	installationType_t { INSTALLATION_RADAR , INSTALLATION_DEFENCE , INSTALLATION_UFOYARD , INSTALLATION_ORBIT , INSTALLATION_TYPE_MAX }

Functions
installation_t *	INS_GetByIDX (int idx)
	Get installation by it's index.
installation_t *	INS_GetFirstUFOYard (bool free)
	returns the first installation with (free) ufostoring capacity
int	INS_GetCount (void)
	Get number of installations.
void	INS_ParseInstallations (const char name, const char *text)
	Copies an entry from the installation description file into the list of installation templates.
const installationTemplate_t *	INS_GetInstallationTemplateByID (const char *id)
	Returns the installation Template for a given installation ID.
const installationTemplate_t *	INS_GetInstallationTemplateByType (installationType_t type)
	Returns the installation Template for a given installation type.
void	INS_LinkTechnologies (void)
bool	INS_HasAny (installationStatus_t status=INSTALLATION_WORKING)
	Checks whether any installation is available.
bool	INS_HasType (installationType_t type, installationStatus_t status=INSTALLATION_WORKING)
	Checks whether the given installation type is available.
installationType_t	INS_GetType (const char *type)
installation_t *	INS_Build (const installationTemplate_t installationTemplate, const vec2_t pos, const char name)
	Build a new installation.
void	INS_UpdateInstallationData (void)
	Check if some installation are build.
void	INS_DestroyInstallation (installation_t *installation)
	Destroys an installation.
installation_t *	INS_GetCurrentSelectedInstallation (void)
	Returns the current selected installation.
void	INS_SetCurrentSelectedInstallation (const installation_t *installation)
	Sets the currently selected installation.
void	INS_SelectInstallation (installation_t *installation)
	Select an installation when clicking on it on geoscape.
void	INS_InitStartup (void)
	Resets console commands.
void	INS_Shutdown (void)
	Closing operations for installations subsystem.

Variables
installation_t *	installationCurrent
vec2_t	newInstallationPos

Detailed Description

Header for installation management related stuff.

Definition in file cp_installation.h.

Macro Definition Documentation

◆ INS_Foreach

#define INS_Foreach ( var )

Value:

LIST_Foreach(ccs.installations, installation_t, var)

ccs

ccs_t ccs

Definition cp_campaign.cpp:63

LIST_Foreach

#define LIST_Foreach(list, type, var)

Iterates over a linked list, it's safe to delete the returned entry from the list while looping over ...

Definition list.h:41

installation_t

A installation with all it's data.

Definition cp_installation.h:73

Definition at line 104 of file cp_installation.h.

Referenced by AII_UpdateInstallationDelay(), AIRFIGHT_CampaignRunBaseDefence(), BDEF_AutoSelectTarget(), CL_DisplayPopupInterceptUFO(), CL_PopupInterceptBaseClick_f(), CP_InterceptChooseInstallation(), GEO_Click(), GEO_DrawMarkers(), GEO_GetGeoscapeAngle(), INS_GetByIDX(), INS_GetCurrentSelectedInstallation(), INS_HasAny(), INS_SaveXML(), INS_SetCurrentSelectedInstallation(), INS_UpdateInstallationData(), RADAR_AddDetectedUFOToEveryRadar(), RADAR_CheckRadarSensored(), RADAR_DeactivateRadarOverlay(), RADAR_NotifyUFORemoved(), RADAR_UpdateStaticRadarCoverage(), UFO_CampaignCheckEvents(), UFO_UpdateAlienInterestForAllBasesAndInstallations(), and UR_DialogInitStore_f().

◆ INS_ForeachOfType

#define INS_ForeachOfType	(		var,
			installationType )

Value:

INS_Foreach(var) \

if ((var)->installationTemplate->type != (installationType)) continue; else

INS_Foreach

#define INS_Foreach(var)

Definition cp_installation.h:104

Definition at line 105 of file cp_installation.h.

Referenced by CP_CheckTriggerEvent(), INS_GetFirstUFOYard(), INS_HasType(), and US_FillUFOTransfer_f().

◆ INS_GetInstallationIDX

#define INS_GetInstallationIDX ( installation )

Value:

((installation)->idx)

Definition at line 109 of file cp_installation.h.

◆ MAX_INSTALLATION_BATTERIES

#define MAX_INSTALLATION_BATTERIES 5

Definition at line 31 of file cp_installation.h.

◆ MAX_INSTALLATION_DAMAGE

#define MAX_INSTALLATION_DAMAGE 100

Definition at line 30 of file cp_installation.h.

◆ MAX_INSTALLATION_TEMPLATES

#define MAX_INSTALLATION_TEMPLATES 6

Definition at line 28 of file cp_installation.h.

Referenced by INS_ParseInstallations().

◆ MAX_INSTALLATIONS_PER_BASE

#define MAX_INSTALLATIONS_PER_BASE 3

Definition at line 27 of file cp_installation.h.

Referenced by B_GetInstallationLimit(), and TEST_F().

Enumeration Type Documentation

◆ installationStatus_t

enum installationStatus_t

Possible installation states.

Note: : Don't change the order or you have to change the installationmenu scriptfiles, too

Enumerator
INSTALLATION_NOT_USED	installation is not set yet
INSTALLATION_UNDER_CONSTRUCTION	installation is under construction
INSTALLATION_WORKING	nothing special, it's working

Definition at line 37 of file cp_installation.h.

◆ installationType_t

enum installationType_t

Enumerator
INSTALLATION_RADAR
INSTALLATION_DEFENCE
INSTALLATION_UFOYARD
INSTALLATION_ORBIT
INSTALLATION_TYPE_MAX

Definition at line 43 of file cp_installation.h.

Function Documentation

◆ INS_Build()

installation_t * INS_Build	(	const installationTemplate_t *	installationTemplate,
		const vec2_t	pos,
		const char *	name )

Build a new installation.

Parameters

[in]	installationTemplate	Template pointer
[in]	pos	Position on Globe to build at
[in]	name	The name of the installation - might already be in utf-8

Definition at line 146 of file cp_installation.cpp.

References installation_t::alienInterest, installation_t::buildStart, ccs, installation_t::idx, INSTALLATION_UNDER_CONSTRUCTION, installation_t::installationDamage, installation_t::installationStatus, installation_t::installationTemplate, LIST_Add(), installationTemplate_t::maxDamage, installation_t::name, name, OBJZERO, installation_t::pos, Q_strncpyz(), installation_t::radar, RADAR_Initialise(), and Vector2Copy.

Referenced by CP_SpawnUFOCarrier_f(), CreateInstallation(), and INS_BuildInstallation_f().

◆ INS_DestroyInstallation()

void INS_DestroyInstallation ( installation_t * installation )

Destroys an installation.

Parameters

[in,out] installation Pointer to the installation to be destroyed

Definition at line 177 of file cp_installation.cpp.

References _, ccs, cgi, Com_sprintf(), cp_messageBuffer, CP_MissionNotifyInstallationDestroyed(), INS_GetCount(), capacities_t::max, MSG_CONSTRUCTION, MSO_CheckAddNewMessage(), installation_t::name, NT_INSTALLATION_DESTROY, RADAR_UpdateInstallationRadarCoverage(), installation_t::ufoCapacity, and US_RemoveUFOsExceedingCapacity().

Referenced by CP_InterceptMissionLeave(), and INS_DestroyInstallation_f().

◆ INS_GetByIDX()

installation_t * INS_GetByIDX ( int idx )

Get installation by it's index.

Parameters

[in] idx Instalation's index

Returns: Pointer to the installation corresponding to idx or nullptr if not found.

Definition at line 94 of file cp_installation.cpp.

References INS_Foreach.

Referenced by INS_DestroyInstallation_f(), INS_FillUFOYardData_f(), INS_SelectInstallation_f(), MIS_LoadXML(), UR_DialogStartStore_f(), US_FillUFOTransferUFOs_f(), US_LoadXML(), and US_TransferUFO_f().

◆ INS_GetCount()

int INS_GetCount ( void )

Get number of installations.

Definition at line 40 of file cp_installation.cpp.

References ccs, and cgi.

Referenced by GEO_GetGeoscapeAngle(), INS_BuildInstallation_f(), INS_DestroyInstallation(), INS_FillTypes_f(), INS_InitCallbacks(), INS_LoadXML(), and INS_SelectType_f().

◆ INS_GetCurrentSelectedInstallation()

installation_t * INS_GetCurrentSelectedInstallation ( void )

Returns the current selected installation.

Definition at line 200 of file cp_installation.cpp.

References INS_Foreach.

Referenced by BDEF_AddItem_f(), BDEF_BaseDefenceMenuUpdate_f(), BDEF_ChangeAutoFire(), BDEF_RemoveItem_f(), BDEF_SelectItem_f(), INS_ChangeInstallationName_f(), INS_DestroyInstallation_f(), and INS_FillUFOYardData_f().

◆ INS_GetFirstUFOYard()

installation_t * INS_GetFirstUFOYard ( bool free )

returns the first installation with (free) ufostoring capacity

Parameters

[in] free On true it gives the first UFO Yard with free space

Returns: installation_t Pointer to the UFO Yard

Definition at line 314 of file cp_installation.cpp.

References INS_ForeachOfType, and INSTALLATION_UFOYARD.

Referenced by INS_FillUFOYardData_f().

◆ INS_GetInstallationTemplateByID()

const installationTemplate_t * INS_GetInstallationTemplateByID ( const char * id )

Returns the installation Template for a given installation ID.

Parameters

[in] id ID of the installation template to find.

Returns: corresponding installation Template, nullptr if not found.

Definition at line 109 of file cp_installation.cpp.

References ccs, installationTemplate_t::id, and Q_streq.

Referenced by INS_BuildInstallation_f(), and INS_SelectType_f().

◆ INS_GetInstallationTemplateByType()

const installationTemplate_t * INS_GetInstallationTemplateByType ( installationType_t type )

Returns the installation Template for a given installation type.

Parameters

[in] type Type of the installation template to find.

Returns: corresponding installation Template, nullptr if not found.

Definition at line 127 of file cp_installation.cpp.

References ccs, installationTemplate_t::type, and type.

Referenced by CP_SpawnUFOCarrier_f(), CreateInstallation(), INS_LoadXML(), and INS_SetInstallationTitle().

◆ INS_GetType()

installationType_t INS_GetType ( const char * type )

Definition at line 45 of file cp_installation.cpp.

References cgi, INSTALLATION_DEFENCE, INSTALLATION_ORBIT, INSTALLATION_RADAR, INSTALLATION_UFOYARD, Q_streq, and type.

Referenced by CP_CheckTriggerEvent(), INS_LoadXML(), and INS_ParseInstallations().

◆ INS_HasAny()

bool INS_HasAny ( installationStatus_t status )

Checks whether any installation is available.

Parameters

[in] status Status of installation to search for

Definition at line 64 of file cp_installation.cpp.

References INS_Foreach, and INSTALLATION_NOT_USED.

Referenced by CP_InterceptMissionSet().

◆ INS_HasType()

bool INS_HasType	(	installationType_t	type,
		installationStatus_t	status )

Checks whether the given installation type is available.

Parameters

[in]	type	Installation type to search for
[in]	status	Status of installation to search for

Definition at line 79 of file cp_installation.cpp.

References INS_ForeachOfType, INSTALLATION_NOT_USED, and type.

Referenced by CP_AttackUFOCarrier_f(), CP_CheckTriggerEvent(), CP_UFOCarrierMissionUpdate(), INS_FillTypes_f(), and INS_SelectType_f().

◆ INS_InitStartup()

void INS_InitStartup ( void )

Resets console commands.

Definition at line 336 of file cp_installation.cpp.

References cgi, and debugInstallationCmds.

Referenced by CP_InitStartup().

◆ INS_LinkTechnologies()

void INS_LinkTechnologies ( void )

Definition at line 451 of file cp_installation.cpp.

References ccs, i, installationTemplate_t::id, RS_GetTechByProvided(), and installationTemplate_t::tech.

Referenced by CP_ParseCampaignData().

◆ INS_ParseInstallations()

void INS_ParseInstallations	(	const char *	name,
		const char **	text )

Copies an entry from the installation description file into the list of installation templates.

Note: Parses one "installation" entry in the installation.ufo file and writes it into the next free entry in installationTemplates.

Parameters

[in]	name	Unique test-id of a installationTemplate_t.
[in]	text	the rest of the script file that is tokenized here

Definition at line 392 of file cp_installation.cpp.

References ccs, cgi, Com_Parse(), cp_campaignPool, DEBUG_CLIENT, i, installationTemplate_t::id, INS_GetType(), INSTALLATION_RADAR, installation_vals, MAX_INSTALLATION_TEMPLATES, name, OBJZERO, Q_streq, and installationTemplate_t::type.

Referenced by CP_ParseScriptFirst().

◆ INS_SelectInstallation()

void INS_SelectInstallation ( installation_t * installation )

Select an installation when clicking on it on geoscape.

Parameters

[in] installation The installation to select

Note: This is (and should be) the only place where installationCurrent is set to a value that is not nullptr

Definition at line 57 of file cp_installation_callbacks.cpp.

References B_SetCurrentSelectedBase(), installation_t::buildStart, installationTemplate_t::buildTime, ccs, cgi, DEBUG_CLIENT, installation_t::idx, INS_SetCurrentSelectedInstallation(), INSTALLATION_DEFENCE, INSTALLATION_UFOYARD, INSTALLATION_WORKING, installation_t::installationStatus, installation_t::installationTemplate, MA_NONE, ngettext, and installationTemplate_t::type.

Referenced by INS_SelectInstallation_f().

◆ INS_SetCurrentSelectedInstallation()

void INS_SetCurrentSelectedInstallation ( const installation_t * installation )

Sets the currently selected installation.

Parameters

installation Pointer to the installation to select

See also: INS_SelectInstallation

Definition at line 215 of file cp_installation.cpp.

References cgi, installationTemplate_t::id, INS_Foreach, installation_t::installationTemplate, installation_t::name, and installation_t::selected.

Referenced by B_SetCurrentSelectedBase(), and INS_SelectInstallation().

◆ INS_Shutdown()

void INS_Shutdown ( void )

Closing operations for installations subsystem.

Definition at line 344 of file cp_installation.cpp.

References ccs, cgi, and debugInstallationCmds.

Referenced by CP_Shutdown().

◆ INS_UpdateInstallationData()

void INS_UpdateInstallationData ( void )

Check if some installation are build.

Note: Daily called.

Definition at line 354 of file cp_installation.cpp.

References _, ccs, Com_sprintf(), cp_messageBuffer, INS_FinishInstallation(), INS_Foreach, INSTALLATION_UNDER_CONSTRUCTION, lengthof, MSG_CONSTRUCTION, MSO_CheckAddNewMessage(), and NT_INSTALLATION_BUILDFINISH.

Referenced by CP_CampaignRun(), and CreateInstallation().

Variable Documentation

◆ installationCurrent

installation_t* installationCurrent

extern

Currently displayed/accessed base.

◆ newInstallationPos

vec2_t newInstallationPos

extern

Coordinates to place the new installation at (long, lat)

Data Structures

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ INS_Foreach

◆ INS_ForeachOfType

◆ INS_GetInstallationIDX

◆ MAX_INSTALLATION_BATTERIES

◆ MAX_INSTALLATION_DAMAGE

◆ MAX_INSTALLATION_TEMPLATES

◆ MAX_INSTALLATIONS_PER_BASE

Enumeration Type Documentation

◆ installationStatus_t

◆ installationType_t

Function Documentation

◆ INS_Build()

◆ INS_DestroyInstallation()

◆ INS_GetByIDX()

◆ INS_GetCount()

◆ INS_GetCurrentSelectedInstallation()

◆ INS_GetFirstUFOYard()

◆ INS_GetInstallationTemplateByID()

◆ INS_GetInstallationTemplateByType()

◆ INS_GetType()

◆ INS_HasAny()

◆ INS_HasType()

◆ INS_InitStartup()

◆ INS_LinkTechnologies()

◆ INS_ParseInstallations()

◆ INS_SelectInstallation()

◆ INS_SetCurrentSelectedInstallation()

◆ INS_Shutdown()

◆ INS_UpdateInstallationData()

Variable Documentation

◆ installationCurrent

◆ newInstallationPos