Header file for inventory handling and Equipment menu. More...

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

Enumerations
enum	itemFilterTypes_t { FILTER_S_PRIMARY , FILTER_S_SECONDARY , FILTER_S_HEAVY , FILTER_S_MISC , FILTER_S_ARMOUR , FILTER_S_IMPLANT , MAX_SOLDIER_FILTERTYPES , FILTER_CRAFTITEM , FILTER_UGVITEM , FILTER_AIRCRAFT , FILTER_DUMMY , FILTER_DISASSEMBLY , MAX_FILTERTYPES , FILTER_ENSURE_32BIT = 0x7FFFFFFF }
	A list of filter types in the market and production view. More...

Functions
bool	INV_MoveItem (Inventory inv, const invDef_t toContainer, int px, int py, const invDef_t fromContainer, Item fItem, Item **tItem)
	Move item between containers.
bool	INV_LoadWeapon (const Item weapon, Inventory inv, const invDef_t srcContainer, const invDef_t destContainer)
	Load a weapon with ammo.
bool	INV_UnloadWeapon (Item weapon, Inventory inv, const invDef_t *container)
	Unload a weapon and put the ammo in a container.
const equipDef_t *	INV_GetEquipmentDefinitionByID (const char *name)
	Gets equipment definition by id.
void	INV_InitStartup (void)
itemFilterTypes_t	INV_GetFilterFromItem (const objDef_t *obj)
const char *	INV_GetFilterType (itemFilterTypes_t id)
itemFilterTypes_t	INV_GetFilterTypeID (const char *filterTypeID)
	Searches for a filter type name (as used in console functions) and returns the matching itemFilterTypes_t enum.
bool	INV_ItemMatchesFilter (const objDef_t *obj, const itemFilterTypes_t filterType)
	Checks if the given object/item matched the given filter type.
Item *	INV_SearchInInventoryWithFilter (const Inventory const i, const invDef_t container, const objDef_t *item, const itemFilterTypes_t filterType) __attribute__((nonnull(1)))
	Searches if there is an item at location (x/y) in a scrollable container. You can also provide an item to search for directly (x/y is ignored in that case).
void	INV_ItemDescription (const objDef_t *od)
	Prints the description for items (weapons, armour, ...).

Detailed Description

Header file for inventory handling and Equipment menu.

Definition in file cl_inventory.h.

Enumeration Type Documentation

◆ itemFilterTypes_t

enum itemFilterTypes_t

A list of filter types in the market and production view.

Note: Run-time only, please do not use this in savegame/structures and the like. Please also do not use hardcoded numbers to access this (e.g. in a .ufo script).

See also: inv_shared.c:INV_ItemMatchesFilter; inv_shared.c:INV_GetFilterTypeID

Enumerator
FILTER_S_PRIMARY	All 'Primary' weapons and their ammo for soldiers (Except for heavy weapons).
FILTER_S_SECONDARY	All 'Secondary' weapons and their ammo for soldiers.
FILTER_S_HEAVY	Heavy weapons for soldiers.
FILTER_S_MISC	Misc. soldier equipment (i.e. everything else that is not in the other soldier-item filters)
FILTER_S_ARMOUR	Armour for soldiers.
FILTER_S_IMPLANT	Implants
MAX_SOLDIER_FILTERTYPES
FILTER_CRAFTITEM	Aircraft equipment.
FILTER_UGVITEM	Heavy equipment like tanks (i.e. these are actually employees) and their parts. Some of the content are special normal items (like for soldiers). The UGVs themself are specially handled.
FILTER_AIRCRAFT	Aircrafts.
FILTER_DUMMY	Everything that is not in any of the other filter types. Mostly plot-relevant stuff, unproducible stuff and stuff.
FILTER_DISASSEMBLY
MAX_FILTERTYPES
FILTER_ENSURE_32BIT

Definition at line 35 of file cl_inventory.h.

Function Documentation

◆ INV_GetEquipmentDefinitionByID()

const equipDef_t * INV_GetEquipmentDefinitionByID ( const char * name )

Gets equipment definition by id.

Parameters

[in] name An id taken from scripts.

Returns: Found equipDef_t or nullptr if no equipment definition found.

Definition at line 39 of file cl_inventory.cpp.

References Com_Error(), csi, ERR_DROP, i, equipDef_t::id, name, and Q_streq.

Referenced by GAME_AutoTeam(), GAME_ChangeEquip(), GAME_GetCGameAPI(), GAME_GetEquipment(), GAME_GetImportData(), and GAME_Spawn().

◆ INV_GetFilterFromItem()

itemFilterTypes_t INV_GetFilterFromItem ( const objDef_t * obj )

Todo: need to implement everything

Definition at line 240 of file cl_inventory.cpp.

References FILTER_S_ARMOUR, FILTER_S_HEAVY, FILTER_S_IMPLANT, FILTER_S_MISC, FILTER_S_PRIMARY, FILTER_S_SECONDARY, objDef_t::id, objDef_t::implant, objDef_t::isArmour(), objDef_t::isHeavy, objDef_t::isMisc, objDef_t::isPrimary, objDef_t::isSecondary, and Sys_Error().

Referenced by INV_LoadWeapon(), and INV_UpdateObject_f().

◆ INV_GetFilterType()

const char * INV_GetFilterType ( itemFilterTypes_t id )

Parameters

[in] id The filter type index

Definition at line 419 of file cl_inventory.cpp.

References filterTypeNames, id, and MAX_FILTERTYPES.

Referenced by GAME_GetImportData().

◆ INV_GetFilterTypeID()

itemFilterTypes_t INV_GetFilterTypeID ( const char * filterTypeID )

Searches for a filter type name (as used in console functions) and returns the matching itemFilterTypes_t enum.

Parameters

[in] filterTypeID Filter type name so search for.

See also: filterTypeNames.

Definition at line 397 of file cl_inventory.cpp.

References FILTER_S_PRIMARY, filterTypeNames, i, MAX_FILTERTYPES, and Q_streq.

Referenced by GAME_GetImportData(), and cgame_import_t::itemFilterTypes_t().

◆ INV_InitStartup()

void INV_InitStartup ( void )

Definition at line 425 of file cl_inventory.cpp.

References Cmd_AddCommand(), INV_EquipmentDefSanityCheck(), and INV_InitCallbacks().

Referenced by CL_InitLocal().

◆ INV_ItemDescription()

void INV_ItemDescription ( const objDef_t * od )

Prints the description for items (weapons, armour, ...).

Parameters

[in] od The object definition of the item

Note: Not only called from UFOpaedia but also from other places to display weapon and ammo statistics

Todo: Do we need to add checks for od->isDummy here somewhere?

Todo: is there ammo with no firedefs?

Definition at line 67 of file cl_inventory_callbacks.cpp.

References _, objDef_t::ammo, objDef_t::ammos, CL_WeaponSkillToName(), Com_sprintf(), count, csi, currentDisplayedObject, Cvar_ForceSet(), Cvar_Set(), fireDef_t::damage, itemEffect_t::duration, objDef_t::fd, fireModeIndex, objDef_t::fireTwoHanded, GAME_ItemIsUseable(), i, damageType_t::id, objDef_t::id, objDef_t::implant, objDef_t::isAmmo(), objDef_t::isArmour(), itemEffect_t::isPermanent, itemIndex, fireDef_t::name, objDef_t::name, objDef_t::numAmmos, objDef_t::numFiredefs, objDef_t::numWeapons, itemEffect_t::period, objDef_t::price, Q_strcat(), fireDef_t::range, objDef_t::ratings, fireDef_t::shots, damageType_t::showInMenu, objDef_t::size, fireDef_t::spldmg, fireDef_t::spread, objDef_t::strengthenEffect, TEXT_ITEMDESCRIPTION, fireDef_t::time, UI_ExecuteConfunc(), UI_MAX_SMALLTEXTLEN, UI_RegisterText(), UI_ResetData(), UNIT_SIZE, objDef_t::weapon, objDef_t::weapons, fireDef_t::weaponSkill, objDef_t::weight, and WEIGHT_FACTOR.

Referenced by GAME_GetImportData(), INV_DecreaseFiremode_f(), INV_DecreaseItem_f(), INV_IncreaseFiremode_f(), INV_IncreaseItem_f(), INV_UpdateObject_f(), and cgame_import_t::void().

◆ INV_ItemMatchesFilter()

bool INV_ItemMatchesFilter	(	const objDef_t *	obj,
		const itemFilterTypes_t	filterType )

Checks if the given object/item matched the given filter type.

Parameters

[in]	obj	A pointer to an objDef_t item.
[in]	filterType	Filter type to check against.

Returns: true if obj is in filterType

Todo: Should we handle FILTER_AIRCRAFT here as well?

Todo: I guess we should search for components matching this item here.

Definition at line 268 of file cl_inventory.cpp.

References Com_Printf(), FILTER_AIRCRAFT, FILTER_CRAFTITEM, FILTER_DISASSEMBLY, FILTER_DUMMY, FILTER_ENSURE_32BIT, FILTER_S_ARMOUR, FILTER_S_HEAVY, FILTER_S_IMPLANT, FILTER_S_MISC, FILTER_S_PRIMARY, FILTER_S_SECONDARY, FILTER_UGVITEM, i, objDef_t::implant, INV_ItemMatchesFilter(), objDef_t::isArmour(), objDef_t::isCraftItem(), objDef_t::isDummy, objDef_t::isHeavy, objDef_t::isMisc, objDef_t::isPrimary, objDef_t::isSecondary, objDef_t::isUGVitem, MAX_FILTERTYPES, MAX_SOLDIER_FILTERTYPES, objDef_t::numWeapons, Q_streq, objDef_t::type, and objDef_t::weapons.

Referenced by cgame_import_t::bool(), GAME_GetImportData(), INV_EquipmentDefSanityCheck(), INV_ItemMatchesFilter(), INV_SearchInInventoryWithFilter(), and UI_ContainerItemIteratorNext().

◆ INV_LoadWeapon()

bool INV_LoadWeapon	(	const Item *	weaponList,
		Inventory *	inv,
		const invDef_t *	srcContainer,
		const invDef_t *	destContainer )

Load a weapon with ammo.

Parameters

[in]	weaponList	Pointer to weapon to load.
[in]	inv	Pointer to inventory where the change happen.
[in]	srcContainer	Pointer to inventorydef where to search ammo.
[in]	destContainer	Pointer to inventorydef where the weapon is.

Definition at line 99 of file cl_inventory.cpp.

References objDef_t::ammo, objDef_t::ammos, Item::def(), Item::getFirstShapePosition(), Inventory::getItemAtPos(), Item::getX(), Item::getY(), i, INV_GetFilterFromItem(), INV_MoveItem(), INV_SearchInInventoryWithFilter(), objDef_t::isReloadable(), objDef_t::numAmmos, Item::setAmmoDef(), Item::setAmmoLeft(), and objDef_t::weapons.

Referenced by uiContainerNode::onDndFinished(), and UI_ContainerNodeAutoPlaceItem().

◆ INV_MoveItem()

bool INV_MoveItem	(	Inventory *	inv,
		const invDef_t *	toContainer,
		int	toX,
		int	toY,
		const invDef_t *	fromContainer,
		Item *	fItem,
		Item **	uponItem )

Move item between containers.

Parameters

[in]	inv	Pointer to the inventory we are working on.
[in]	toContainer	Pointer to target container, to place the item in.
[in]	toX	target x position in the toContainer container.
[in]	toY	target y position in the toContainer container.
[in]	fromContainer	Pointer to source container, the item is in.
[in]	fItem	Pointer to item being moved.
[out]	uponItem	The item the moving item is eventually dropped upon.

Note: If you set toX or toY to -1/NONE the item is automatically placed on; a free spot in the targetContainer

Returns: true if the move was successful.

Definition at line 63 of file cl_inventory.cpp.

References _, Inventory::canHoldItemWeight(), cls, GAME_GetChrMaxLoad(), GAME_GetSelectedChr(), IA_ARMOUR, IA_MOVE, IA_RELOAD, IA_RELOAD_SWAP, invDef_t::id, SHAPE_BIG_MAX_HEIGHT, SHAPE_BIG_MAX_WIDTH, and UI_Popup().

Referenced by INV_LoadWeapon(), uiContainerNode::onDndFinished(), UI_ContainerNodeAddItem(), and UI_ContainerNodeAutoPlaceItem().

◆ INV_SearchInInventoryWithFilter()

Item * INV_SearchInInventoryWithFilter	(	const Inventory *const	inv,
		const invDef_t *	container,
		const objDef_t *	itemType,
		const itemFilterTypes_t	filterType )

Searches if there is an item at location (x/y) in a scrollable container. You can also provide an item to search for directly (x/y is ignored in that case).

Note: x = x-th item in a row, y = row. i.e. x/y does not equal the "grid" coordinates as used in those containers.

Parameters

[in]	inv	Pointer to the inventory where we will search.
[in]	container	Container in the inventory.
[in]	itemType	The item to search. Will ignore "x" and "y" if set, it'll also search invisible items.
[in]	filterType	Enum definition of type (types of items for filtering purposes).