Header for slot management related stuff. More...

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

Enumerations
enum	zoneaircraftParams_t { ZONE_NONE , ZONE_MAIN , ZONE_AMMO , ZONE_MAX }
	Zone number in airequip menu or base defence menu. More...
enum	ammoStatus_t { AMMO_STATUS_NOT_SET = -1 , AMMO_STATUS_NO_MORE_AMMO = 0 }
	Different status for numAmmo. More...
enum	basedefenceType_t { BASEDEF_RANDOM , BASEDEF_MISSILE , BASEDEF_LASER , BASEDEF_MAX }
	The different possible types of base defence systems. More...

Functions
void	BDEF_AddBattery (basedefenceType_t basedefType, base_t *base)
	Adds a defence system to base.
void	BDEF_RemoveBattery (base_t *base, basedefenceType_t basedefType, int idx)
	Remove a base defence sytem from base.
void	BDEF_InitialiseBaseSlots (base_t *base)
	Initialise all values of base slot defence.
void	BDEF_InitialiseInstallationSlots (installation_t *installation)
	Initialise all values of installation slot defence.
void	BDEF_ReloadBattery (void)
void	BDEF_AutoSelectTarget (void)
	Chooses target for all base defences and sam sites.
technology_t **	AII_GetCraftitemTechsByType (aircraftItemType_t type)
	Returns a list of craftitem technologies for the given type.
void	AII_UpdateInstallationDelay (void)
	Update the installation delay of all slots of a given aircraft.
bool	AII_AddItemToSlot (base_t base, const technology_t tech, aircraftSlot_t *slot, bool nextItem)
	Add an item to an aircraft slot.
bool	AII_AddAmmoToSlot (base_t base, const technology_t tech, aircraftSlot_t *slot)
	Add an ammo to an aircraft weapon slot.
void	AII_RemoveItemFromSlot (base_t base, aircraftSlot_t slot, bool ammo)
	Remove the item from the slot (or optionally its ammo only) and put it the base storage.
void	AII_RemoveNextItemFromSlot (base_t base, aircraftSlot_t slot, bool ammo)
	Cancel replacing item, move nextItem (or optionally its ammo only) back to the base storage.
bool	AIM_PilotAssignedAircraft (const base_t base, const Employee pilot)
	Checks to see if the pilot is in any aircraft at this base.
void	AIM_AutoEquipAircraft (aircraft_t *aircraft)
	Auto Add weapon and ammo to an aircraft.
void	AII_InitialiseSlot (aircraftSlot_t slot, aircraft_t aircraft, base_t base, installation_t installation, aircraftItemType_t type)
	Initialise values of one slot of an aircraft or basedefence common to all types of items.
float	AIR_GetMaxAircraftWeaponRange (const aircraftSlot_t *slot, int maxSlot)
	Get the maximum weapon range of aircraft.
void	AII_RepairAircraft (void)
	Repair aircraft.
void	AII_UpdateAircraftStats (aircraft_t *aircraft)
	Update the value of stats array of an aircraft.
int	AII_BaseCanShoot (const base_t *base)
	Check if the base has weapon and ammo.
bool	AII_InstallationCanShoot (const installation_t *installation)
	Check if the installation has a weapon and ammo.
itemWeight_t	AII_GetItemWeightBySize (const objDef_t *od)
	Returns craftitem weight based on size.
const char *	AII_WeightToName (itemWeight_t weight)
	Translate a weight int to a translated string.
void	AII_AutoAddAmmo (aircraftSlot_t *slot)
	Auto add ammo corresponding to weapon, if there is enough in storage.
bool	AIM_SelectableCraftItem (const aircraftSlot_t slot, const technology_t tech)
	Check if an aircraft item should or should not be displayed in airequip menu.
aircraftSlot_t *	BDEF_GetBaseSlotByIDX (base_t *base, aircraftItemType_t type, int idx)
	returns the aircraftSlot of a base at an index or the first free slot
aircraftSlot_t *	BDEF_GetInstallationSlotByIDX (installation_t *installation, aircraftItemType_t type, int idx)
	returns the aircraftSlot of an installaion at an index or the first free slot
aircraftSlot_t *	AII_GetAircraftSlotByIDX (aircraft_t *aircraft, aircraftItemType_t type, int idx)
	returns the aircraftSlot of an aircraft at an index or the first free slot
bool	AII_ReloadWeapon (aircraftSlot_t *slot)
	Reloads an aircraft/defence-system weapon.
void	AII_ReloadAircraftWeapons (aircraft_t *aircraft)
	Reload the weapons of an aircraft.
void	AII_SaveOneSlotXML (xmlNode_t p, const aircraftSlot_t slot, bool weapon)
	Save callback for savegames in XML Format.
void	AII_LoadOneSlotXML (xmlNode_t node, aircraftSlot_t slot, bool weapon)
	Loads one slot (base, installation or aircraft).

Detailed Description

Header for slot management related stuff.

Definition in file cp_mapfightequip.h.

Enumeration Type Documentation

◆ ammoStatus_t

enum ammoStatus_t

Different status for numAmmo.

Todo: do we still need this?

Enumerator
AMMO_STATUS_NOT_SET	This weapon can't shoot yet.
AMMO_STATUS_NO_MORE_AMMO	This weapon has no ammo.

Definition at line 46 of file cp_mapfightequip.h.

◆ basedefenceType_t

enum basedefenceType_t

The different possible types of base defence systems.

See also: BDEF_RemoveBattery_f: BASEDEF_LASER must be just after BASEDEF_MISSILE

Enumerator
BASEDEF_RANDOM	The base defence system should be randomly selected.
BASEDEF_MISSILE	The base defence system is a missile battery.
BASEDEF_LASER	The base defence system is a laser battery.
BASEDEF_MAX

Definition at line 57 of file cp_mapfightequip.h.

◆ zoneaircraftParams_t

enum zoneaircraftParams_t

Zone number in airequip menu or base defence menu.

Note: A zone is the rectangular box in the upper right of the screen.; A zone is different from a slot or the type of an item.

Enumerator
ZONE_NONE	This is not a zone (used when no zone is selected).
ZONE_MAIN	This is the upper (1st) zone containing the current item installed in the slot.
ZONE_AMMO	This is the lowest (3rd) zone containing the ammo fitting the weapon in ZONE_MAIN Therefore, this zone should only be used when 1st zone contain an WEAPON.
ZONE_MAX

Definition at line 33 of file cp_mapfightequip.h.

Function Documentation

◆ AII_AddAmmoToSlot()

bool AII_AddAmmoToSlot	(	base_t *	base,
		const technology_t *	tech,
		aircraftSlot_t *	slot )

Add an ammo to an aircraft weapon slot.

Note: No check for the type of item is done here, so it must be done before.

Parameters

[in]	base	Pointer to the base which provides items (nullptr if items shouldn't be removed of storage)
[in]	tech	Pointer to the tech to add to slot
[in]	slot	Pointer to the slot where you want to add ammos

See also: AII_AddItemToSlot

Definition at line 647 of file cp_mapfightequip.cpp.

References AC_ITEM_AMMO, AII_ReloadWeapon(), AII_RemoveItemFromSlot(), AII_RemoveNextItemFromSlot(), aircraftSlot_t::ammo, objDef_t::ammos, B_AddToStorage(), B_BaseHasItem(), cgi, objDef_t::craftitem, objDef_t::id, objDef_t::idx, INVSH_GetItemByID(), aircraftSlot_t::item, aircraftSlot_t::nextAmmo, aircraftSlot_t::nextItem, objDef_t::numAmmos, technology_t::provides, and craftItem::type.

Referenced by AII_AutoAddAmmo(), AII_LoadOneSlotXML(), and AIM_AircraftEquipAddItem_f().

◆ AII_AddItemToSlot()

bool AII_AddItemToSlot	(	base_t *	base,
		const technology_t *	tech,
		aircraftSlot_t *	slot,
		bool	nextItem )

Add an item to an aircraft slot.

Parameters

[in]	base	Pointer to the base where item will be removed (nullptr for ufos, virtual ammos or while loading game)
[in]	tech	Pointer to the tech that will be added in this slot.
[in]	slot	Pointer to the aircraft, base, or installation slot.
[in]	nextItem	False if we are changing current item in slot, true if this is the item to install after current removal is over.

Note: No check for the type of item is done here.

See also: AII_UpdateOneInstallationDelay; AII_AddAmmoToSlot

Definition at line 722 of file cp_mapfightequip.cpp.

References AC_ITEM_AMMO, AII_GetItemWeightBySize(), B_AddToStorage(), B_BaseHasItem(), cgi, objDef_t::craftitem, objDef_t::id, aircraftSlot_t::idx, aircraftSlot_t::installationTime, craftItem::installationTime, INVSH_GetItemByID(), aircraftSlot_t::item, aircraftSlot_t::nextItem, technology_t::provides, aircraftSlot_t::size, objDef_t::size, aircraftSlot_t::type, and craftItem::type.

Referenced by AII_LoadOneSlotXML(), AIM_AircraftEquipAddItem_f(), AIM_AutoEquipAircraft(), and BDEF_AddItem_f().

◆ AII_AutoAddAmmo()

void AII_AutoAddAmmo ( aircraftSlot_t * slot )

Auto add ammo corresponding to weapon, if there is enough in storage.

Parameters

[in] slot Pointer to the slot where you want to add ammo

See also: AIM_AircraftEquipAddItem_f; AII_RemoveItemFromSlot

Definition at line 433 of file cp_mapfightequip.cpp.

References AC_ITEM_WEAPON, AII_AddAmmoToSlot(), AIM_SelectableCraftItem(), AIR_IsAircraftInBase(), AIR_IsUFO, aircraftSlot_t::aircraft, aircraftSlot_t::ammo, objDef_t::ammos, aircraftSlot_t::base, objDef_t::craftitem, objDef_t::isVirtual, aircraftSlot_t::item, aircraftSlot_t::nextAmmo, aircraftSlot_t::nextItem, objDef_t::numAmmos, RS_GetTechForItem(), and craftItem::type.

Referenced by AII_ReloadWeapon(), AIM_AircraftEquipAddItem_f(), AIM_AutoEquipAircraft(), and BDEF_AddItem_f().

◆ AII_BaseCanShoot()

int AII_BaseCanShoot ( const base_t * base )

Check if the base has weapon and ammo.

Parameters

[in] base Pointer to the base you want to check (may not be nullptr)

Returns: true if the base can shoot, qflase else

See also: AII_AircraftCanShoot

Definition at line 1150 of file cp_mapfightequip.cpp.

References AII_WeaponsCanShoot(), B_DEFENCE_LASER, B_DEFENCE_MISSILE, B_GetBuildingStatus(), base_t::batteries, base_t::lasers, base_t::numBatteries, and base_t::numLasers.

Referenced by AIRFIGHT_CampaignRunBaseDefence(), CL_DisplayPopupInterceptUFO(), CL_PopupInterceptBaseClick_f(), and GEO_DrawMapOneBase().

◆ AII_GetAircraftSlotByIDX()

aircraftSlot_t * AII_GetAircraftSlotByIDX	(	aircraft_t *	aircraft,
		aircraftItemType_t	type,
		int	idx )

returns the aircraftSlot of an aircraft at an index or the first free slot

Parameters

[in]	aircraft	Pointer to aircraft
[in]	type	base defence type, see aircraftItemType_t
[in]	idx	index of aircraftslot

Returns: the aircraftSlot at the index idx if idx non-negative the first free slot otherwise

Definition at line 964 of file cp_mapfightequip.cpp.

References AC_ITEM_ELECTRONICS, AC_ITEM_SHIELD, AC_ITEM_WEAPON, aircraft_t::electronics, i, aircraftSlot_t::item, aircraft_t::maxElectronics, aircraft_t::maxWeapons, aircraftSlot_t::nextItem, aircraft_t::shield, type, and aircraft_t::weapons.

◆ AII_GetCraftitemTechsByType()

technology_t ** AII_GetCraftitemTechsByType ( aircraftItemType_t type )

Returns a list of craftitem technologies for the given type.

Note: This list is terminated by a nullptr pointer.

Parameters

[in] type Type of the craft-items to return.

Definition at line 44 of file cp_mapfightequip.cpp.

References cgi, objDef_t::craftitem, i, INVSH_GetItemByIDX(), MAX_TECHNOLOGIES, RS_GetTechForItem(), craftItem::type, and type.

Referenced by AIM_UpdateAircraftItemList(), BDEF_AddItem_f(), BDEF_SelectItem_f(), and BDEF_UpdateAircraftItemList().

◆ AII_GetItemWeightBySize()

itemWeight_t AII_GetItemWeightBySize ( const objDef_t * od )

Returns craftitem weight based on size.

Parameters

[in] od Pointer to objDef_t object being craftitem.

Returns: itemWeight_t

See also: AII_WeightToName

Definition at line 74 of file cp_mapfightequip.cpp.

References ITEM_HEAVY, ITEM_LIGHT, ITEM_MEDIUM, and objDef_t::size.

Referenced by AII_AddItemToSlot(), AIM_AutoEquipAircraft(), AIM_CheckTechnologyIntoSlot(), AIM_SelectableCraftItem(), AIR_ScriptSanityCheck(), and UP_AircraftItemDescription().

◆ AII_InitialiseSlot()

void AII_InitialiseSlot	(	aircraftSlot_t *	slot,
		aircraft_t *	aircraftTemplate,
		base_t *	base,
		installation_t *	installation,
		aircraftItemType_t	type )

Initialise values of one slot of an aircraft or basedefence common to all types of items.

Parameters

[in]	slot	Pointer to the slot to initialize.
[in]	aircraftTemplate	Template Pointer to aircraft template.
[in]	base	Pointer to base.
[in]	installation	Pointer to the thing being installed.
[in]	type	The type of item that can fit in this slot.

sa BDEF_AddBattery: it needs to be AMMO_STATUS_NOT_SET and not 0

See also: B_SaveBaseSlots

Definition at line 847 of file cp_mapfightequip.cpp.

References aircraftSlot_t::aircraft, aircraftSlot_t::ammo, AMMO_STATUS_NOT_SET, aircraftSlot_t::ammoLeft, aircraftSlot_t::base, aircraftSlot_t::installation, aircraftSlot_t::installationTime, aircraftSlot_t::item, ITEM_HEAVY, aircraftSlot_t::nextAmmo, aircraftSlot_t::nextItem, OBJZERO, aircraftSlot_t::size, aircraftSlot_t::type, and type.

Referenced by AII_InitialiseAircraftSlots(), BDEF_InitialiseBaseSlots(), BDEF_InitialiseInstallationSlots(), and BDEF_RemoveBattery().

◆ AII_InstallationCanShoot()

bool AII_InstallationCanShoot ( const installation_t * installation )

Check if the installation has a weapon and ammo.

Parameters

[in] installation Pointer to the installation you want to check (may not be nullptr)

Returns: true if the installation can shoot, qflase else

See also: AII_AircraftCanShoot

Definition at line 1173 of file cp_mapfightequip.cpp.

References AII_WeaponsCanShoot(), installation_t::batteries, INSTALLATION_WORKING, installation_t::installationStatus, installation_t::installationTemplate, and installationTemplate_t::maxBatteries.

Referenced by AIRFIGHT_CampaignRunBaseDefence(), CL_DisplayPopupInterceptUFO(), CL_PopupInterceptBaseClick_f(), and GEO_DrawMapOneInstallation().

◆ AII_LoadOneSlotXML()

void AII_LoadOneSlotXML	(	xmlNode_t *	node,
		aircraftSlot_t *	slot,
		bool	weapon )

Loads one slot (base, installation or aircraft).

Parameters

[in]	node	XML Node structure, where we get the information from
[out]	slot	Pointer to the slot where item should be added.
[in]	weapon	True if the slot is a weapon slot.

See also: B_Load; B_SaveAircraftSlots

Definition at line 1333 of file cp_mapfightequip.cpp.

References AII_AddAmmoToSlot(), AII_AddItemToSlot(), aircraftSlot_t::ammoLeft, cgi, aircraftSlot_t::delayNextShot, aircraftSlot_t::installationTime, name, RS_GetTechByProvided(), SAVE_SLOT_AMMOID, SAVE_SLOT_AMMOLEFT, SAVE_SLOT_DELAYNEXTSHOT, SAVE_SLOT_INSTALLATIONTIME, SAVE_SLOT_ITEMID, SAVE_SLOT_NEXTAMMOID, SAVE_SLOT_NEXTITEMID, and xmlNode_t.

Referenced by AIR_LoadAircraftSlotsXML(), and B_LoadBaseSlotsXML().

◆ AII_ReloadAircraftWeapons()

void AII_ReloadAircraftWeapons ( aircraft_t * aircraft )

Reload the weapons of an aircraft.

Parameters

[in,out] aircraft Pointer to the aircraft to reload

Definition at line 630 of file cp_mapfightequip.cpp.

References AII_ReloadWeapon(), i, aircraft_t::maxWeapons, and aircraft_t::weapons.

Referenced by AIM_AircraftStart_f(), AIR_SendAircraftPursuingUFO(), AIR_SendAircraftToMission(), B_AircraftReturnedToHomeBase(), and UFO_AddToGeoscape().

◆ AII_ReloadWeapon()

bool AII_ReloadWeapon ( aircraftSlot_t * slot )

Reloads an aircraft/defence-system weapon.

Parameters

[in,out] slot Pointer to the aircraftSlot where weapon is attached to

Returns: true on success - if the weapon was reloaded OR it didn't need reload

Definition at line 567 of file cp_mapfightequip.cpp.

References AII_AutoAddAmmo(), AII_UpdateAircraftStats(), AIR_IsAircraftInBase(), AIR_IsUFO, aircraftSlot_t::aircraft, AIRCRAFT_RELOAD_DELAY_MULTIPLIER, aircraftSlot_t::ammo, objDef_t::ammo, aircraftSlot_t::ammoLeft, B_AddToStorage(), B_BaseHasItem(), aircraftSlot_t::base, BASE_RELOAD_DELAY_MULTIPLIER, cgi, objDef_t::craftitem, aircraftSlot_t::delayNextShot, ERR_DROP, aircraftSlot_t::installation, INSTALLATION_RELOAD_DELAY_MULTIPLIER, aircraftSlot_t::item, UFO_RELOAD_DELAY_MULTIPLIER, and craftItem::weaponDelay.

Referenced by AII_AddAmmoToSlot(), AII_ReloadAircraftWeapons(), AIR_CampaignRun(), AIRFIGHT_AddProjectile(), and AIRFIGHT_CampaignRunBaseDefence().

◆ AII_RemoveItemFromSlot()

void AII_RemoveItemFromSlot	(	base_t *	base,
		aircraftSlot_t *	slot,
		bool	ammo )

Remove the item from the slot (or optionally its ammo only) and put it the base storage.

Note: if there is another item to install after removal, begin this installation.; virtual items cannot be removed!

Parameters

[in]	base	The base to add the item to (may be nullptr if item shouldn't be removed from any base).
[in]	slot	The slot to remove the item from.
[in]	ammo	true if we want to remove only ammo. false if the whole item should be removed.

See also: AII_AddItemToSlot; AII_AddAmmoToSlot; AII_RemoveNextItemFromSlot

Definition at line 482 of file cp_mapfightequip.cpp.

References AII_RemoveItemFromSlot(), aircraftSlot_t::ammo, objDef_t::ammo, aircraftSlot_t::ammoLeft, B_AddToStorage(), objDef_t::craftitem, aircraftSlot_t::installationTime, craftItem::installationTime, objDef_t::isVirtual, aircraftSlot_t::item, aircraftSlot_t::nextAmmo, and aircraftSlot_t::nextItem.

Referenced by AII_AddAmmoToSlot(), AII_RemoveItemFromSlot(), AII_UpdateOneInstallationDelay(), AIM_AircraftEquipAddItem_f(), AIM_AircraftEquipRemoveItem_f(), AIR_DeleteAircraft(), BDEF_AddItem_f(), and BDEF_RemoveItem_f().

◆ AII_RemoveNextItemFromSlot()

void AII_RemoveNextItemFromSlot	(	base_t *	base,
		aircraftSlot_t *	slot,
		bool	ammo )

Cancel replacing item, move nextItem (or optionally its ammo only) back to the base storage.

Parameters

[in]	base	The base to add the item to (may be nullptr if item shouldn't be removed from any base).
[in]	slot	The slot to remove the item from.
[in]	ammo	true if we want to remove only ammo. false if the whole item should be removed.