inventory definition with all its containers More...

#include <inv_shared.h>

Collaboration diagram for Inventory:

Public Member Functions
	Inventory ()
virtual	~Inventory ()
void	init ()
const Container &	getContainer (const containerIndex_t idx) const
Item *	getContainer2 (const containerIndex_t idx) const
void	setContainer (const containerIndex_t idx, Item *cont)
void	resetContainer (const containerIndex_t idx)
void	resetTempContainers ()
bool	containsItem (const containerIndex_t contId, const Item *const item) const
	Searches if there is a specific item already in the inventory&container.
Item *	getArmour () const
Item *	getHeadgear () const
Item *	getRightHandContainer () const
Item *	getLeftHandContainer () const
Item *	getHolsterContainer () const
Item *	getEquipContainer () const
Item *	getImplantContainer () const
Item *	getFloorContainer () const
void	setFloorContainer (Item *cont)
void	findSpace (const invDef_t container, const Item item, int const px, int const py, const Item *ignoredItem) const
	Finds space for item in inv at container.
Item *	findInContainer (const containerIndex_t contId, const Item *const item) const
	Searches a specific item in the inventory&container.
Item *	getItemAtPos (const invDef_t *container, const int x, const int y) const
	Searches if there is an item at location (x,y) in a container.
int	getWeight () const
	Get the weight of the items in the given inventory (excluding those in temp containers).
int	canHoldItem (const invDef_t container, const objDef_t od, const int x, const int y, const Item *ignoredItem) const
bool	canHoldItemWeight (containerIndex_t from, containerIndex_t to, const Item &item, int maxWeight) const
	Check that adding an item to the inventory won't exceed the max permitted weight.
bool	holdsReactionFireWeapon () const
	Checks if there is a weapon in the hands that can be used for reaction fire.
const Container *	getNextCont (const Container *prev, bool inclTemp=false) const
int	countItems () const
	Count the number of items in the inventory (without temp containers).

Protected Member Functions
const Container *	_getNextCont (const Container *prev) const

Protected Attributes
Container	_containers [MAX_CONTAINERS]

Detailed Description

inventory definition with all its containers

Definition at line 525 of file inv_shared.h.

Constructor & Destructor Documentation

◆ Inventory()

Inventory::Inventory ( )

Definition at line 692 of file inv_shared.cpp.

References init().

◆ ~Inventory()

virtual Inventory::~Inventory ( )

inlinevirtual

Definition at line 534 of file inv_shared.h.

Member Function Documentation

◆ _getNextCont()

const Container * Inventory::_getNextCont ( const Container * prev ) const

protected

Todo: : convert into iterator

Definition at line 710 of file inv_shared.cpp.

References _containers, and CID_MAX.

Referenced by getNextCont().

◆ canHoldItem()

int Inventory::canHoldItem	(	const invDef_t *	container,
		const objDef_t *	od,
		const int	x,
		const int	y,
		const Item *	ignoredItem ) const

Parameters

[in]	container	The index of the container in the inventory to check the item in.
[in]	od	The type of item to check in the inventory.
[in]	x	The x value in the container (1 << x in the shape bitmask)
[in]	y	The y value in the container (SHAPE_BIG_MAX_HEIGHT is the max)
[in]	ignoredItem	You can ignore one item in the container (most often the currently dragged one). Use nullptr if you want to check against all items in the container.

Returns: INV_DOES_NOT_FIT if the item does not fit; INV_FITS if it fits and; INV_FITS_ONLY_ROTATED if it fits only when rotated 90 degree (to the left).; INV_FITS_BOTH if it fits either normally or when rotated 90 degree (to the left).

< Return INV_FITS_BOTH if both if statements where true above.

< We are returning with status true (1) if the item does not fit at all - unlikely but not impossible.

Todo: aren't both (equip and floor) temp container?

< Return INV_FITS_BOTH if both if statements where true above.

Definition at line 761 of file inv_shared.cpp.

References invDef_t::all, invDef_t::armour, CID_LEFT, CID_RIGHT, Com_DPrintf(), containsItem(), DEBUG_SHARED, objDef_t::fireTwoHanded, getContainer2(), objDef_t::getShapeRotated(), invDef_t::headgear, objDef_t::headgear, objDef_t::holdTwoHanded, invDef_t::id, invDef_t::implant, objDef_t::implant, INV_DOES_NOT_FIT, INV_FITS, INV_FITS_ONLY_ROTATED, INVSH_CheckToInventory_shape(), objDef_t::isArmour(), invDef_t::isEquipDef(), invDef_t::isFloorDef(), invDef_t::isLeftDef(), invDef_t::isRightDef(), invDef_t::scroll, objDef_t::shape, invDef_t::single, and invDef_t::unique.

Referenced by InventoryInterface::addToInventory(), findSpace(), InventoryInterface::moveInInventory(), InventoryInterface::tryAddToInventory(), and UI_ContainerNodeDrawFreeSpace().

◆ canHoldItemWeight()

bool Inventory::canHoldItemWeight	(	containerIndex_t	from,
		containerIndex_t	to,
		const Item &	item,
		int	maxWeight ) const

Check that adding an item to the inventory won't exceed the max permitted weight.

Parameters

[in]	from	Index of the container the item comes from.
[in]	to	Index of the container the item is being placed.
[in]	item	The item that is being added.
[in]	maxWeight	The max permitted weight.

Returns: true if it is Ok to add the item false otherwise.

Definition at line 919 of file inv_shared.cpp.

References CSI, getArmour(), getWeight(), Item::getWeight(), and Item::isArmour().

Referenced by CL_ActorInvMove(), G_ActorInvMove(), G_ClientReadInventory(), GAME_LoadInventory(), and INV_MoveItem().

◆ containsItem()

bool Inventory::containsItem	(	const containerIndex_t	contId,
		const Item *const	item ) const

inline

Searches if there is a specific item already in the inventory&container.

Parameters

[in]	contId	Container in the inventory.
[in]	item	The item to search for.

Returns: true if there already is at least one item of this type, otherwise false.

Definition at line 572 of file inv_shared.h.

References findInContainer().

Referenced by canHoldItem(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

◆ countItems()

int Inventory::countItems ( ) const

Count the number of items in the inventory (without temp containers).

Definition at line 741 of file inv_shared.cpp.

References Container::countItems(), and getNextCont().

Referenced by GAME_NetSendInventory().

◆ findInContainer()

Item * Inventory::findInContainer	(	const containerIndex_t	contId,
		const Item *const	searchItem ) const

Searches a specific item in the inventory&container.

Parameters

[in]	contId	Container in the inventory.
[in]	searchItem	The item to search for.

Returns: Pointer to the first item of this type found, otherwise nullptr.

Definition at line 1001 of file inv_shared.cpp.

References getContainer(), Container::getNextItem(), and Item::isSameAs().

Referenced by containsItem().

◆ findSpace()

void Inventory::findSpace	(	const invDef_t *	container,
		const Item *	item,
		int *const	px,
		int *const	py,
		const Item *	ignoredItem ) const

Finds space for item in inv at container.

Parameters

[in]	item	The item to check the space for
[in]	container	The container to search in
[out]	px	The x position in the container
[out]	py	The y position in the container
[in]	ignoredItem	You can ignore one item in the container (most often the currently dragged one). Use nullptr if you want to check against all items in the container.