#include <Inventory.h>

Inheritance diagram for CharacterInventory:

Public Member Functions
	CharacterInventory ()

int	size () const

int	capacity () const

Sizei	gridSize () const

Recti	gridRect () const

auto	entries (this auto &&self)

auto	entries (this auto &&self, ItemId itemId)

auto	equipment (this auto &&self)

auto	functionalEquipment (this auto &&self)

InventoryEntry	entry (Pointi position)

InventoryConstEntry	entry (Pointi position) const

InventoryEntry	entry (ItemSlot slot)

InventoryConstEntry	entry (ItemSlot slot) const

InventoryEntry	entry (int index)

InventoryConstEntry	entry (int index) const

InventoryEntry	functionalEntry (ItemSlot slot)

InventoryConstEntry	functionalEntry (ItemSlot slot) const

bool	canAdd (Pointi position, Sizei size) const

bool	canAdd (Pointi position, const Item &item) const

bool	canAdd (Sizei size) const

bool	canAdd (const Item &item) const

InventoryEntry	add (Pointi position, const Item &item)

InventoryEntry	add (const Item &item)

InventoryEntry	tryAdd (Pointi position, const Item &item)

InventoryEntry	tryAdd (const Item &item)

bool	canEquip (ItemSlot slot) const

InventoryEntry	equip (ItemSlot slot, const Item &item)

InventoryEntry	tryEquip (ItemSlot slot, const Item &item)

Item	take (InventoryEntry entry)

std::optional< Pointi >	findSpace (Sizei size) const

std::optional< Pointi >	findSpace (const Item &item) const

InventoryEntry	find (ItemId itemId)

InventoryConstEntry	find (ItemId itemId) const

void	clear ()

Friends
class	Inventory

void	snapshot (const CharacterInventory &src, Character_MM7 *dst)

void	reconstruct (const Character_MM7 &src, CharacterInventory *dst, ContextTag< int > characterIndex)

Additional Inherited Members
Private Member Functions inherited from Inventory
	Inventory (Sizei gridSize, int capacity)

	Inventory ()

int	size () const

int	capacity () const

Sizei	gridSize () const

Recti	gridRect () const

auto	entries (this auto &&self)

auto	entries (this auto &&self, ItemId itemId)

auto	equipment (this auto &&self)

auto	functionalEquipment (this auto &&self)

InventoryEntry	entry (Pointi position)

InventoryConstEntry	entry (Pointi position) const

InventoryEntry	entry (ItemSlot slot)

InventoryConstEntry	entry (ItemSlot slot) const

InventoryEntry	functionalEntry (ItemSlot slot)

InventoryConstEntry	functionalEntry (ItemSlot slot) const

InventoryEntry	entry (int index)

InventoryConstEntry	entry (int index) const

bool	canAdd (Pointi position, Sizei size) const

bool	canAdd (Pointi position, const Item &item) const

bool	canAdd (Sizei size) const

bool	canAdd (const Item &item) const

InventoryEntry	add (Pointi position, const Item &item)

InventoryEntry	add (const Item &item)

InventoryEntry	tryAdd (Pointi position, const Item &item)

InventoryEntry	tryAdd (const Item &item)

bool	canEquip (ItemSlot slot) const

InventoryEntry	equip (ItemSlot slot, const Item &item)

InventoryEntry	tryEquip (ItemSlot slot, const Item &item)

bool	canStash () const

InventoryEntry	stash (const Item &item)

InventoryEntry	tryStash (const Item &item)

Item	take (InventoryEntry entry)

std::optional< Pointi >	findSpace (Sizei size) const

std::optional< Pointi >	findSpace (const Item &item) const

InventoryEntry	find (ItemId itemId)

InventoryConstEntry	find (ItemId itemId) const

void	clear ()

Static Private Attributes inherited from Inventory
static constexpr std::size_t	MAX_ITEMS = 140

Detailed Description

Thin facade that exposes only the character‑appropriate subset of Inventory interface.

Constructor & Destructor Documentation

◆ CharacterInventory()

CharacterInventory::CharacterInventory ( )

inline

Member Function Documentation

◆ add() [1/2]

InventoryEntry Inventory::add ( const Item & item )

◆ add() [2/2]

InventoryEntry Inventory::add	(	Pointi	position,
		const Item &	item
	)

◆ canAdd() [1/4]

bool Inventory::canAdd ( const Item & item ) const

inline

◆ canAdd() [2/4]

bool Inventory::canAdd	(	Pointi	position,
		const Item &	item
	)		const

inline

◆ canAdd() [3/4]

bool Inventory::canAdd	(	Pointi	position,
		Sizei	size
	)		const

◆ canAdd() [4/4]

bool Inventory::canAdd ( Sizei size ) const

◆ canEquip()

bool Inventory::canEquip ( ItemSlot slot ) const

◆ capacity()

int Inventory::capacity ( ) const

inline

Returns: How many items can this inventory object hold.

◆ clear()

void Inventory::clear ( )

◆ entries() [1/2]

auto Inventory::entries ( this auto && self )

inline

Parameters

self *this.

Returns: A range of InventoryEntry or InventoryConstEntry objects for items in this inventory. Returned entries are never invalid.

◆ entries() [2/2]

auto Inventory::entries	(	this auto &&	self,
		ItemId	itemId
	)

inline

Parameters

self	`*this`.
itemId	Item id to filter for.

Returns: A range of InventoryEntry or InventoryConstEntry objects for items in this inventory with the given itemId. Returned entries are never invalid.

◆ entry() [1/6]

InventoryEntry Inventory::entry ( int index )

Parameters

index Entry index to look up an item.

Returns: Inventory entry at index, or an invalid entry if index is out of bounds or if there is no item at index.

◆ entry() [2/6]

InventoryConstEntry Inventory::entry ( int index ) const

inline

◆ entry() [3/6]

InventoryEntry Inventory::entry ( ItemSlot slot )

Parameters

slot	Equipment slot to look up an item.

Returns: Inventory entry for an item equipped in slot, or an invalid entry if that slot is empty.

◆ entry() [4/6]

InventoryConstEntry Inventory::entry ( ItemSlot slot ) const

inline

◆ entry() [5/6]

InventoryEntry Inventory::entry ( Pointi position )

Parameters

position Grid position to look up an item.

Returns: Inventory entry at provided grid position, or an invalid entry if position is out of bounds or if the grid at position is empty.

◆ entry() [6/6]

InventoryConstEntry Inventory::entry ( Pointi position ) const

inline

◆ equip()

InventoryEntry Inventory::equip	(	ItemSlot	slot,
		const Item &	item
	)

◆ equipment()

auto Inventory::equipment ( this auto && self )

inline

Parameters

self *this.

Returns: A range of InventoryEntry or InventoryConstEntry objects for all equipped items in this inventory. Returned entries are never invalid.

◆ find() [1/2]

InventoryEntry Inventory::find ( ItemId itemId )

◆ find() [2/2]

InventoryConstEntry Inventory::find ( ItemId itemId ) const

inline

◆ findSpace() [1/2]

std::optional< Pointi > Inventory::findSpace ( const Item & item ) const

inline

◆ findSpace() [2/2]

std::optional< Pointi > Inventory::findSpace ( Sizei size ) const

◆ functionalEntry() [1/2]

InventoryEntry Inventory::functionalEntry ( ItemSlot slot )

inline

Parameters

slot	Equipment slot to look up an item.

Returns: Inventory entry for an item equipped in slot, or an invalid entry if that slot is empty or if the item in the slot is non-functional (broken or out of charges).

◆ functionalEntry() [2/2]

InventoryConstEntry Inventory::functionalEntry ( ItemSlot slot ) const

inline

◆ functionalEquipment()

auto Inventory::functionalEquipment ( this auto && self )

inline

Parameters

self *this.

Returns: A range of InventoryEntry or InventoryConstEntry objects for all equipped items in this inventory that are functional (non-broken and not out of charges). Returned entries are never invalid.

◆ gridRect()

Recti Inventory::gridRect ( ) const

inline

Returns: Rect for this inventory's grid, in cells. Mainly useful for checks like inventory.gridRect().contains(pos).

◆ gridSize()

Sizei Inventory::gridSize ( ) const

inline

Returns: Size of this inventory's grid, in cells.

◆ size()

int Inventory::size ( ) const

inline

Returns: How many items are currently held in this inventory object.

◆ take()

Item Inventory::take ( InventoryEntry entry )

◆ tryAdd() [1/2]

InventoryEntry Inventory::tryAdd ( const Item & item )

◆ tryAdd() [2/2]

InventoryEntry Inventory::tryAdd	(	Pointi	position,
		const Item &	item
	)

◆ tryEquip()

InventoryEntry Inventory::tryEquip	(	ItemSlot	slot,
		const Item &	item
	)

Friends And Related Function Documentation

◆ Inventory

friend class Inventory

friend

◆ reconstruct

void reconstruct	(	const Character_MM7 &	src,
		CharacterInventory *	dst,
		ContextTag< int >	characterIndex
	)

friend

◆ snapshot

void snapshot	(	const CharacterInventory &	src,
		Character_MM7 *	dst
	)

friend

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

src/Engine/Objects/Inventory.h

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CharacterInventory()

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ canAdd() [1/4]

◆ canAdd() [2/4]

◆ canAdd() [3/4]

◆ canAdd() [4/4]

◆ canEquip()

◆ capacity()

◆ clear()

◆ entries() [1/2]

◆ entries() [2/2]

◆ entry() [1/6]

◆ entry() [2/6]

◆ entry() [3/6]

◆ entry() [4/6]

◆ entry() [5/6]

◆ entry() [6/6]

◆ equip()

◆ equipment()

◆ find() [1/2]

◆ find() [2/2]

◆ findSpace() [1/2]

◆ findSpace() [2/2]

◆ functionalEntry() [1/2]

◆ functionalEntry() [2/2]

◆ functionalEquipment()

◆ gridRect()

◆ gridSize()

◆ size()

◆ take()

◆ tryAdd() [1/2]

◆ tryAdd() [2/2]

◆ tryEquip()

Friends And Related Function Documentation

◆ Inventory

◆ reconstruct

◆ snapshot