Handles everything that is located in or accessed through an installation. More...

#include "../../cl_shared.h"
#include "../../../shared/parse.h"
#include "cp_campaign.h"
#include "cp_mapfightequip.h"
#include "cp_aircraft.h"
#include "cp_missions.h"
#include "cp_installation.h"
#include "save/save_installation.h"

Functions
int	INS_GetCount (void)
	Get number of installations. More...

installationType_t	INS_GetType (const char *type)

bool	INS_HasAny (installationStatus_t status)
	Checks whether any installation is available. More...

bool	INS_HasType (installationType_t type, installationStatus_t status)
	Checks whether the given installation type is available. More...

installation_t *	INS_GetByIDX (int idx)
	Get installation by it's index. More...

const installationTemplate_t *	INS_GetInstallationTemplateByID (const char *id)
	Returns the installation Template for a given installation ID. More...

const installationTemplate_t *	INS_GetInstallationTemplateByType (installationType_t type)
	Returns the installation Template for a given installation type. More...

installation_t *	INS_Build (const installationTemplate_t installationTemplate, const vec2_t pos, const char name)
	Build a new installation. More...

void	INS_DestroyInstallation (installation_t *installation)
	Destroys an installation. More...

installation_t *	INS_GetCurrentSelectedInstallation (void)
	Returns the current selected installation. More...

void	INS_SetCurrentSelectedInstallation (const installation_t *installation)
	Sets the currently selected installation. More...

static void	INS_FinishInstallation (installation_t *installation)
	Finishes an installation. More...

installation_t *	INS_GetFirstUFOYard (bool free)
	returns the first installation with (free) ufostoring capacity More...

void	INS_InitStartup (void)
	Resets console commands. More...

void	INS_Shutdown (void)
	Closing operations for installations subsystem. More...

void	INS_UpdateInstallationData (void)
	Check if some installation are build. More...

void	INS_ParseInstallations (const char name, const char *text)
	Copies an entry from the installation description file into the list of installation templates. More...

void	INS_LinkTechnologies (void)

bool	INS_SaveXML (xmlNode_t *p)
	Save callback for savegames in xml. More...

bool	INS_LoadXML (xmlNode_t *p)
	Load callback for savegames. More...

Variables
static const cmdList_t	debugInstallationCmds []

static const value_t	installation_vals []

Detailed Description

Handles everything that is located in or accessed through an installation.

Note: Installation functions prefix: INS_*

Definition in file cp_installation.cpp.

Function Documentation

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 145 of file cp_installation.cpp.

References installation_s::alienInterest, installation_s::buildStart, ccs_s::campaignStats, ccs, ccs_s::date, date_s::day, installation_s::idx, INSTALLATION_UNDER_CONSTRUCTION, installation_s::installationDamage, ccs_s::installations, stats_s::installationsBuilt, installation_s::installationStatus, installation_s::installationTemplate, LIST_Add(), installationTemplate_s::maxDamage, installation_s::name, OBJZERO, installation_s::pos, Q_strncpyz(), installation_s::radar, RADAR_Initialise(), and Vector2Copy.

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

void INS_DestroyInstallation ( installation_t * installation )

Destroys an installation.

Parameters

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

Definition at line 176 of file cp_installation.cpp.

References _, ccs, cgi, Com_sprintf(), cp_messageBuffer, CP_MissionNotifyInstallationDestroyed(), cgame_import_s::Cvar_Set(), INS_GetCount(), ccs_s::installations, capacities_s::max, MSG_CONSTRUCTION, MSO_CheckAddNewMessage(), installation_s::name, NT_INSTALLATION_DESTROY, RADAR_UpdateInstallationRadarCoverage(), installation_s::ufoCapacity, and US_RemoveUFOsExceedingCapacity().

Referenced by CP_InterceptMissionLeave(), and INS_DestroyInstallation_f().

static void INS_FinishInstallation ( installation_t * installation )

static

Finishes an installation.

Parameters

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

See also: INS_UpdateInstallationData; INS_ConstructionFinished_f

Definition at line 234 of file cp_installation.cpp.

References BDEF_InitialiseInstallationSlots(), cgi, DEBUG_CLIENT, ERR_DROP, INSTALLATION_UNDER_CONSTRUCTION, INSTALLATION_WORKING, installation_s::installationStatus, installation_s::installationTemplate, capacities_s::max, installationTemplate_s::maxBatteries, installationTemplate_s::maxUFOsStored, installation_s::numBatteries, RADAR_UpdateInstallationRadarCoverage(), installationTemplate_s::radarRange, installationTemplate_s::trackingRange, and installation_s::ufoCapacity.

Referenced by INS_UpdateInstallationData().

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 93 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().

int INS_GetCount ( void )

Get number of installations.

Definition at line 39 of file cp_installation.cpp.

References ccs, cgi, and ccs_s::installations.

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

installation_t* INS_GetCurrentSelectedInstallation ( void )

Returns the current selected installation.

Definition at line 199 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().

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 313 of file cp_installation.cpp.

References INS_ForeachOfType, and INSTALLATION_UFOYARD.

Referenced by INS_FillUFOYardData_f().

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 108 of file cp_installation.cpp.

References ccs, installationTemplate_s::id, mission_s::idx, ccs_s::installationTemplates, ccs_s::numInstallationTemplates, and Q_streq.

Referenced by INS_BuildInstallation_f(), and INS_SelectType_f().

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 126 of file cp_installation.cpp.

References ccs, mission_s::idx, ccs_s::installationTemplates, ccs_s::numInstallationTemplates, and installationTemplate_s::type.

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

installationType_t INS_GetType ( const char * type )

Definition at line 44 of file cp_installation.cpp.

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

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

bool INS_HasAny ( installationStatus_t status )

Checks whether any installation is available.

Parameters

[in] status Status of installation to search for

Definition at line 63 of file cp_installation.cpp.

References INS_Foreach, and INSTALLATION_NOT_USED.

Referenced by CP_InterceptMissionSet().

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 78 of file cp_installation.cpp.

References INS_ForeachOfType, and INSTALLATION_NOT_USED.

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

void INS_InitStartup ( void )

Resets console commands.

Definition at line 335 of file cp_installation.cpp.

References cgi.

Referenced by CP_InitStartup().

void INS_LinkTechnologies ( void )

Definition at line 450 of file cp_installation.cpp.

References ccs, i, installationTemplate_s::id, ccs_s::installationTemplates, ccs_s::numInstallationTemplates, RS_GetTechByProvided(), and installationTemplate_s::tech.

Referenced by CP_ParseCampaignData().

bool INS_LoadXML ( xmlNode_t * p )

Load callback for savegames.

Parameters

[in] p XML Node structure, where we get the information from

See also: INS_SaveXML; SAV_GameLoadXML; INS_LoadItemSlots

Definition at line 498 of file cp_installation.cpp.

References installation_s::alienInterest, B_LoadBaseSlotsXML(), installation_s::batteries, BDEF_InitialiseInstallationSlots(), installation_s::buildStart, ccs, cgi, capacities_s::cur, cgame_import_s::Cvar_Set(), installation_s::idx, INS_GetCount(), INS_GetInstallationTemplateByType(), INS_GetType(), INSTALLATION_WORKING, installation_s::installationDamage, ccs_s::installations, installation_s::installationStatus, installation_s::installationTemplate, LIST_Add(), capacities_s::max, installationTemplate_s::maxBatteries, installationTemplate_s::maxUFOsStored, installation_s::name, installation_s::numBatteries, OBJZERO, installation_s::pos, Q_strncpyz(), installation_s::radar, RADAR_Initialise(), RADAR_InitialiseUFOs(), RADAR_UpdateInstallationRadarCoverage(), installationTemplate_s::radarRange, SAVE_INSTALLATION_ALIENINTEREST, SAVE_INSTALLATION_BATTERIES, SAVE_INSTALLATION_BUILDSTART, SAVE_INSTALLATION_DAMAGE, SAVE_INSTALLATION_IDX, SAVE_INSTALLATION_INSTALLATION, SAVE_INSTALLATION_INSTALLATIONS, SAVE_INSTALLATION_NAME, SAVE_INSTALLATION_NUM, SAVE_INSTALLATION_POS, SAVE_INSTALLATION_STATUS, SAVE_INSTALLATION_TEMPLATEID, SAVE_INSTALLATIONSTATUS_NAMESPACE, saveInstallationConstants, installationTemplate_s::trackingRange, type, installation_s::ufoCapacity, cgame_import_s::XML_GetNextNode(), cgame_import_s::XML_GetNode(), cgame_import_s::XML_GetPos3(), cgame_import_s::XML_GetString(), and xmlNode_t.

Referenced by SAV_Init().

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 391 of file cp_installation.cpp.

References ccs, cgi, cgame_import_s::Com_EParse(), Com_Parse(), cp_campaignPool, DEBUG_CLIENT, i, installationTemplate_s::id, INS_GetType(), INSTALLATION_RADAR, ccs_s::installationTemplates, MAX_INSTALLATION_TEMPLATES, installationTemplate_s::name, ccs_s::numInstallationTemplates, OBJZERO, cgame_import_s::PoolStrDup(), Q_streq, and installationTemplate_s::type.

Referenced by CP_ParseScriptFirst().

bool INS_SaveXML ( xmlNode_t * p )

Save callback for savegames in xml.

Parameters

[out] p XML Node structure, where we write the information to

See also: INS_LoadXML; SAV_GameSaveXML

Definition at line 466 of file cp_installation.cpp.

Referenced by SAV_Init().

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 214 of file cp_installation.cpp.

References cgi, cgame_import_s::Cvar_Set(), installationTemplate_s::id, INS_Foreach, installation_s::installationTemplate, and installation_s::name.

Referenced by B_SetCurrentSelectedBase(), and INS_SelectInstallation().

void INS_Shutdown ( void )

Closing operations for installations subsystem.

Definition at line 343 of file cp_installation.cpp.

References ccs, cgi, and ccs_s::installations.

Referenced by CP_Shutdown().

void INS_UpdateInstallationData ( void )

Check if some installation are build.

Note: Daily called.

Definition at line 353 of file cp_installation.cpp.

References _, ccs, Com_sprintf(), cp_messageBuffer, ccs_s::date, date_s::day, INS_FinishInstallation(), INS_Foreach, INSTALLATION_UNDER_CONSTRUCTION, lengthof, MSG_CONSTRUCTION, MSO_CheckAddNewMessage(), and NT_INSTALLATION_BUILDFINISH.

Referenced by CP_CampaignRun(), and CreateInstallation().

Variable Documentation

const cmdList_t debugInstallationCmds[]

static

Initial value:

= {
    {nullptr, nullptr, nullptr}
}

Definition at line 325 of file cp_installation.cpp.

const value_t installation_vals[]

static

Initial value:

= {
    {"name", V_TRANSLATION_STRING, offsetof(installationTemplate_t, name), 0},
    {"description", V_TRANSLATION_STRING, offsetof(installationTemplate_t, description), 0},
    {"radar_range", V_INT, offsetof(installationTemplate_t, radarRange), MEMBER_SIZEOF(installationTemplate_t, radarRange)},
    {"radar_tracking_range", V_INT, offsetof(installationTemplate_t, trackingRange), MEMBER_SIZEOF(installationTemplate_t, trackingRange)},
    {"max_batteries", V_INT, offsetof(installationTemplate_t, maxBatteries), MEMBER_SIZEOF(installationTemplate_t, maxBatteries)},
    {"max_ufo_stored", V_INT, offsetof(installationTemplate_t, maxUFOsStored), MEMBER_SIZEOF(installationTemplate_t, maxUFOsStored)},
    {"max_damage", V_INT, offsetof(installationTemplate_t, maxDamage), MEMBER_SIZEOF(installationTemplate_t, maxDamage)},
    {"cost", V_INT, offsetof(installationTemplate_t, cost), MEMBER_SIZEOF(installationTemplate_t, cost)},
    {"buildtime", V_INT, offsetof(installationTemplate_t, buildTime), MEMBER_SIZEOF(installationTemplate_t, buildTime)},
    {"once", V_BOOL, offsetof(installationTemplate_t, once), MEMBER_SIZEOF(installationTemplate_t, once)},
    {"model", V_HUNK_STRING, offsetof(installationTemplate_t, model), 0},
    {"image", V_HUNK_STRING, offsetof(installationTemplate_t, image), 0},
    {nullptr, V_NULL, 0, 0}
}

Definition at line 367 of file cp_installation.cpp.

Functions

Variables

Detailed Description

Function Documentation

Variable Documentation