building_s Struct Reference

A building with all it's data. More...

#include <cp_building.h>

Data Fields
int	idx
struct building_s *	tpl
struct base_s *	base
const char *	id
char *	name
const char *	image
const char *	mapPart
const char *	pedia
vec2_t	size
int	fixCosts
int	varCosts
float	level
date_t	timeStart
int	buildTime
buildingStatus_t	buildingStatus
char *	onConstruct
char *	onDestroy
char *	onEnable
char *	onDisable
int	maxCount
vec2_t	pos
bool	mandatory
int	maxEmployees
buildingType_t	buildingType
struct technology_s *	tech
const struct building_s *	dependsBuilding
int	capacity

Detailed Description

A building with all it's data.

Definition at line 73 of file cp_building.h.

Field Documentation

struct base_s* building_s::base

The base this building is located in.

Definition at line 76 of file cp_building.h.

Referenced by B_BuildBuilding(), B_BuildingDestroy(), B_CheckBuildingConstruction(), B_CheckBuildingDependencesStatus(), B_CheckUpdateBuilding(), B_GetNeighbours(), B_IsBuildingDestroyable(), B_LoadXML(), B_ParseBuildings(), B_UpdateAllBaseBuildingStatus(), and CP_StartSelectedMission().

buildingStatus_t building_s::buildingStatus

Definition at line 94 of file cp_building.h.

Referenced by B_BuildBuilding(), B_BuildingDestroy(), B_BuildingDestroy_f(), B_CheckBuildingConstruction(), B_CheckBuildingTypeStatus(), B_CheckUpdateBuilding(), B_GetMaxBuildingLevel(), B_GetNumberOfBuildingsInBaseByBuildingType(), B_GetNumberOfBuildingsInBaseByTemplate(), B_LoadXML(), B_SaveXML(), B_UpdateAllBaseBuildingStatus(), B_UpdateBaseCapacities(), BDEF_RemoveBattery_f(), CP_GetSalaryUpKeepBase(), and TEST_F().

buildingType_t building_s::buildingType

This way we can rename the buildings without loosing the control.

Note

Not to be confused with "tpl".

Definition at line 110 of file cp_building.h.

Referenced by AIR_CanIntercept(), AIR_GetHangarCapacityType(), B_BuildFromTemplate(), B_BuildingDestroy(), B_BuildingDestroy_f(), B_BuildingOpenAfterClick_f(), B_CheckBuildingDependencesStatus(), B_CheckUpdateBuilding(), B_FireEvent(), B_GetBuildingTemplateByType(), B_GetNextBuildingByType(), B_ListBuildings_f(), B_ParseBuildings(), B_ResetAllStatusAndCapacities(), B_UpdateAllBaseBuildingStatus(), B_UpdateBaseCapacities(), B_UpdateStatusBuilding(), E_HireForBuilding(), and TR_DestinationCapacityList_f().

int building_s::buildTime

Definition at line 92 of file cp_building.h.

Referenced by B_FillBuildingInfo_f(), B_GetConstructionTimeRemain(), B_IsBuildingBuiltUp(), B_LoadXML(), B_SaveXML(), TEST_F(), and UP_BuildingDescription().

int building_s::capacity

Capacity of this building (used in calculate base capacities).

Definition at line 114 of file cp_building.h.

Referenced by B_BuildingDestroy_f(), B_ListBuildings_f(), and B_UpdateBaseCapacities().

const struct building_s* building_s::dependsBuilding

If the building needs another one to work (= to be buildable).

See also

"buildingTemplates" list

Definition at line 112 of file cp_building.h.

Referenced by B_CheckBuildingDependencesStatus(), B_FillBuildingInfo_f(), B_ParseBuildings(), B_UpdateStatusBuilding(), and UP_BuildingDescription().

int building_s::fixCosts

Definition at line 83 of file cp_building.h.

Referenced by B_BuildBuilding(), B_BuildBuilding_f(), B_BuildingDestroy(), B_FillBuildingInfo_f(), and UP_BuildingDescription().

const char* building_s::id

Definition at line 78 of file cp_building.h.

Referenced by B_AddBuildingToBasePos(), B_AssembleMap(), B_BuildingScriptSanityCheck(), B_FillBuildingInfo_f(), B_FillMap_f(), B_GetBuildingTemplateSilent(), B_ListBuildings_f(), B_ParseBaseTemplate(), B_ParseBuildings(), B_SaveXML(), B_UpdateBaseCapacities(), RS_InitTree(), and TR_DestinationCapacityList_f().

int building_s::idx

Index in in the base buildings list.

Definition at line 74 of file cp_building.h.

Referenced by B_BuildBuilding(), B_BuildingDestroy(), B_IsBuildingDestroyable(), B_LoadXML(), B_ParseBuildings(), and B_SaveXML().

const char* building_s::image

Definition at line 80 of file cp_building.h.

Referenced by B_BuildingScriptSanityCheck(), B_FillBuildingInfo_f(), B_FillMap_f(), and RS_InitTree().

float building_s::level

level of the building.

Note

This value depends on the implementation of the affected building might e.g. be a factor

Definition at line 89 of file cp_building.h.

Referenced by B_GetMaxBuildingLevel(), B_LoadXML(), and B_SaveXML().

bool building_s::mandatory

Definition at line 105 of file cp_building.h.

Referenced by B_BuildFromTemplate(), B_BuildingDestroy(), B_ListBuildings_f(), and B_ParseBaseTemplate().

const char * building_s::mapPart

Definition at line 80 of file cp_building.h.

Referenced by B_AssembleMap().

int building_s::maxCount

How many building of the same type allowed?

Definition at line 102 of file cp_building.h.

Referenced by B_FillBuildingInfo_f(), B_ListBuildings_f(), B_ParseBaseTemplate(), and B_ParseBuildings().

int building_s::maxEmployees

How many employees to hire on construction in the first base

Definition at line 108 of file cp_building.h.

Referenced by E_HireForBuilding().

char* building_s::name

translatable name of the building

Definition at line 79 of file cp_building.h.

Referenced by B_BuildingScriptSanityCheck(), B_CheckUpdateBuilding(), B_FillBuildingInfo_f(), B_FillMap_f(), B_ListBuildings_f(), B_UpdateBuildingConstructions(), CAP_CheckOverflow(), RS_InitTree(), TR_DestinationCapacityList_f(), UP_AircraftDescription(), and UP_BuildingDescription().

char* building_s::onConstruct

Event handler functions

Definition at line 97 of file cp_building.h.

Referenced by B_FireEvent().

char* building_s::onDestroy

Definition at line 98 of file cp_building.h.

Referenced by B_BuildingDestroy(), and B_FireEvent().

char* building_s::onDisable

Definition at line 100 of file cp_building.h.

Referenced by B_BuildingDestroy(), and B_FireEvent().

char* building_s::onEnable

Definition at line 99 of file cp_building.h.

Referenced by B_AddBuildingToBasePos(), B_CheckBuildingConstruction(), and B_FireEvent().

const char * building_s::pedia

Definition at line 80 of file cp_building.h.

Referenced by B_BuildingOpenAfterClick_f(), and B_BuildingScriptSanityCheck().

vec2_t building_s::pos

location in the base.

Definition at line 104 of file cp_building.h.

Referenced by B_AddBuildingToBasePos(), B_AssembleMap(), B_BuildBuilding(), B_BuildingDestroy(), B_BuildingDestroy_f(), B_FillMap_f(), B_GetNeighbours(), B_LoadXML(), B_SaveXML(), and TEST_F().

vec2_t building_s::size

Definition at line 82 of file cp_building.h.

Referenced by B_BuildBuilding(), B_BuildBuilding_f(), B_BuildingDestroy(), B_FillMap_f(), B_GetNeighbours(), B_ListBuildings_f(), and B_ParseBuildings().

struct technology_s* building_s::tech

Link to the building-technology.

Definition at line 111 of file cp_building.h.

Referenced by B_ListBuildings_f(), B_ParseBuildings(), and TR_DestinationCapacityList_f().

date_t building_s::timeStart

Definition at line 91 of file cp_building.h.

Referenced by B_AddBuildingToBasePos(), B_BuildBuilding(), B_GetConstructionTimeRemain(), B_IsBuildingBuiltUp(), B_LoadXML(), and B_SaveXML().

struct building_s* building_s::tpl

Self link in "buildingTemplates" list.

Definition at line 75 of file cp_building.h.

Referenced by B_BuildingDestroy(), B_CheckBuildingDependencesStatus(), B_GetNumberOfBuildingsInBaseByTemplate(), B_ListBuildings_f(), B_ParseBuildings(), and B_SaveXML().

int building_s::varCosts

Definition at line 83 of file cp_building.h.

Referenced by B_FillBuildingInfo_f(), CP_GetSalaryUpKeepBase(), and UP_BuildingDescription().

---

The documentation for this struct was generated from the following file:

• src/client/cgame/campaign/cp_building.h