Inheritance diagram for Barotrauma.Inventory:

Classes
class	ItemSlot

Public Member Functions
	Inventory (Entity owner, int capacity, int slotsPerRow=5)

bool	Contains (Item item)
	Is the item contained in this inventory. Does not recursively check items inside items. More...

Item	FirstOrDefault ()
	Return the first item in the inventory, or null if the inventory is empty. More...

Item	LastOrDefault ()
	Return the last item in the inventory, or null if the inventory is empty. More...

Item	GetItemAt (int index)
	Get the item stored in the specified inventory slot. If the slot contains a stack of items, returns the first item in the stack. More...

IEnumerable< Item >	GetItemsAt (int index)
	Get all the item stored in the specified inventory slot. Can return more than one item if the slot contains a stack of items. More...

int	GetItemStackSlotIndex (Item item, int index)

int	FindIndex (Item item)
	Find the index of the first slot the item is contained in. More...

List< int >	FindIndices (Item item)
	Find the indices of all the slots the item is contained in (two-hand items for example can be in multiple slots). Note that this method instantiates a new list. More...

virtual bool	ItemOwnsSelf (Item item)
	Returns true if the item owns any of the parent inventories. More...

virtual int	FindAllowedSlot (Item item, bool ignoreCondition=false)

bool	CanBePut (Item item)
	Can the item be put in the inventory (i.e. is there a suitable free slot or a stack the item can be put in). More...

virtual bool	CanBePutInSlot (Item item, int i, bool ignoreCondition=false)
	Can the item be put in the specified slot. More...

bool	CanBePut (ItemPrefab itemPrefab, float? condition=null, int? quality=null)

virtual bool	CanBePutInSlot (ItemPrefab itemPrefab, int i, float? condition=null, int? quality=null)

int	HowManyCanBePut (ItemPrefab itemPrefab, float? condition=null)

virtual int	HowManyCanBePut (ItemPrefab itemPrefab, int i, float? condition, bool ignoreItemsInSlot=false)

virtual bool	TryPutItem (Item item, Character user, IEnumerable< InvSlotType > allowedSlots=null, bool createNetworkEvent=true, bool ignoreCondition=false)
	If there is room, puts the item in the inventory and returns true, otherwise returns false More...

virtual bool	TryPutItem (Item item, int i, bool allowSwapping, bool allowCombine, Character user, bool createNetworkEvent=true, bool ignoreCondition=false)

bool	IsEmpty ()

virtual bool	IsFull (bool takeStacksIntoAccount=false)
	Is there room to put more items in the inventory. Doesn't take stacking into account by default. More...

void	CreateNetworkEvent ()

Item	FindItem (Func< Item, bool > predicate, bool recursive)

List< Item >	FindAllItems (Func< Item, bool > predicate=null, bool recursive=false, List< Item > list=null)

Item	FindItemByTag (Identifier tag, bool recursive=false)

Item	FindItemByIdentifier (Identifier identifier, bool recursive=false)

virtual void	RemoveItem (Item item)

void	ForceToSlot (Item item, int index)
	Forces an item to a specific slot. Doesn't remove the item from existing slots/inventories or do any other sanity checks, use with caution! More...

void	ForceRemoveFromSlot (Item item, int index)
	Removes an item from a specific slot. Doesn't do any sanity checks, use with caution! More...

bool	IsInSlot (Item item, int index)

void	SharedRead (IReadMessage msg, List< ushort >[] receivedItemIds, out bool readyToApply)

void	SharedWrite (IWriteMessage msg, Range slotRange)

void	DeleteAllItems ()
	Deletes all items inside the inventory (and also recursively all items inside the items) More...

void	ServerEventRead (IReadMessage msg, Client c)

Public Attributes
readonly Entity	Owner

bool	Locked

bool	AllowSwappingContainedItems = true

Static Public Attributes
const int	MaxPossibleStackSize = (1 << 6) - 1

const int	MaxItemsPerNetworkEvent = 128

Protected Member Functions
IEnumerable< Item >	GetAllItems (bool checkForDuplicates)

virtual void	PutItem (Item item, int i, Character user, bool removeItem=true, bool createNetworkEvent=true)

bool	TrySwapping (int index, Item item, Character user, bool createNetworkEvent, bool swapWholeStack)

virtual void	CreateNetworkEvent (Range slotRange)

Protected Attributes
readonly int	capacity

readonly ItemSlot[]	slots

float	syncItemsDelay

Properties
int	ExtraStackSize `[get, set]`

virtual IEnumerable< Item >	AllItems `[get]`
	All items contained in the inventory. Stacked items are returned as individual instances. DO NOT modify the contents of the inventory while enumerating this list. More...

IEnumerable< Item >	AllItemsMod `[get]`
	All items contained in the inventory. Allows modifying the contents of the inventory while being enumerated. More...

int	Capacity `[get]`

int	EmptySlotCount `[get]`

Detailed Description

Definition at line 11 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

Constructor & Destructor Documentation

◆ Inventory()

Barotrauma.Inventory.Inventory	(	Entity	owner,
		int	capacity,
		int	slotsPerRow = `5`
	)

Definition at line 280 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

Member Function Documentation

◆ CanBePut() [1/2]

bool Barotrauma.Inventory.CanBePut ( Item item )

Can the item be put in the inventory (i.e. is there a suitable free slot or a stack the item can be put in).

Definition at line 484 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ CanBePut() [2/2]

bool Barotrauma.Inventory.CanBePut	(	ItemPrefab	itemPrefab,
		float?	condition = `null`,
		int?	quality = `null`
	)

Definition at line 503 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ CanBePutInSlot() [1/2]

virtual bool Barotrauma.Inventory.CanBePutInSlot	(	Item	item,
		int	i,
		bool	ignoreCondition = `false`
	)

virtual

Can the item be put in the specified slot.

Reimplemented in Barotrauma.ItemInventory, and Barotrauma.CharacterInventory.

Definition at line 496 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ CanBePutInSlot() [2/2]

virtual bool Barotrauma.Inventory.CanBePutInSlot	(	ItemPrefab	itemPrefab,
		int	i,
		float?	condition = `null`,
		int?	quality = `null`
	)

virtual

Reimplemented in Barotrauma.ItemInventory, and Barotrauma.CharacterInventory.

Definition at line 512 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ Contains()

bool Barotrauma.Inventory.Contains ( Item item )

Is the item contained in this inventory. Does not recursively check items inside items.

Definition at line 369 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ CreateNetworkEvent() [1/2]

void Barotrauma.Inventory.CreateNetworkEvent ( )

Definition at line 948 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ CreateNetworkEvent() [2/2]

virtual void Barotrauma.Inventory.CreateNetworkEvent ( Range slotRange )

protectedvirtual

Reimplemented in Barotrauma.ItemInventory, and Barotrauma.CharacterInventory.

Definition at line 975 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ DeleteAllItems()

void Barotrauma.Inventory.DeleteAllItems ( )

Deletes all items inside the inventory (and also recursively all items inside the items)

Definition at line 1127 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ FindAllItems()

List<Item> Barotrauma.Inventory.FindAllItems	(	Func< Item, bool >	predicate = `null`,
		bool	recursive = `false`,
		List< Item >	list = `null`
	)

Definition at line 993 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ FindAllowedSlot()

virtual int Barotrauma.Inventory.FindAllowedSlot	(	Item	item,
		bool	ignoreCondition = `false`
	)

virtual

Reimplemented in Barotrauma.ItemInventory.

Definition at line 463 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ FindIndex()

int Barotrauma.Inventory.FindIndex ( Item item )

Find the index of the first slot the item is contained in.

Definition at line 428 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ FindIndices()

List<int> Barotrauma.Inventory.FindIndices ( Item item )

Find the indices of all the slots the item is contained in (two-hand items for example can be in multiple slots). Note that this method instantiates a new list.

Definition at line 440 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ FindItem()

Item Barotrauma.Inventory.FindItem	(	Func< Item, bool >	predicate,
		bool	recursive
	)

Definition at line 977 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ FindItemByIdentifier()

Item Barotrauma.Inventory.FindItemByIdentifier	(	Identifier	identifier,
		bool	recursive = `false`
	)

Definition at line 1016 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ FindItemByTag()

Item Barotrauma.Inventory.FindItemByTag	(	Identifier	tag,
		bool	recursive = `false`
	)

Definition at line 1010 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ FirstOrDefault()

Item Barotrauma.Inventory.FirstOrDefault ( )

Return the first item in the inventory, or null if the inventory is empty.

Definition at line 377 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ ForceRemoveFromSlot()

void Barotrauma.Inventory.ForceRemoveFromSlot	(	Item	item,
		int	index
	)

Removes an item from a specific slot. Doesn't do any sanity checks, use with caution!

Definition at line 1064 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ ForceToSlot()

void Barotrauma.Inventory.ForceToSlot	(	Item	item,
		int	index
	)

Forces an item to a specific slot. Doesn't remove the item from existing slots/inventories or do any other sanity checks, use with caution!

Definition at line 1049 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ GetAllItems()

IEnumerable<Item> Barotrauma.Inventory.GetAllItems ( bool checkForDuplicates )

protected

Definition at line 312 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ GetItemAt()

Item Barotrauma.Inventory.GetItemAt ( int index )

Get the item stored in the specified inventory slot. If the slot contains a stack of items, returns the first item in the stack.

Definition at line 403 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ GetItemsAt()

IEnumerable<Item> Barotrauma.Inventory.GetItemsAt ( int index )

Get all the item stored in the specified inventory slot. Can return more than one item if the slot contains a stack of items.

Definition at line 412 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ GetItemStackSlotIndex()

int Barotrauma.Inventory.GetItemStackSlotIndex	(	Item	item,
		int	index
	)

Definition at line 418 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ HowManyCanBePut() [1/2]

int Barotrauma.Inventory.HowManyCanBePut	(	ItemPrefab	itemPrefab,
		float?	condition = `null`
	)

Definition at line 518 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ HowManyCanBePut() [2/2]

virtual int Barotrauma.Inventory.HowManyCanBePut	(	ItemPrefab	itemPrefab,
		int	i,
		float?	condition,
		bool	ignoreItemsInSlot = `false`
	)

virtual

Reimplemented in Barotrauma.ItemInventory.

Definition at line 528 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ IsEmpty()

bool Barotrauma.Inventory.IsEmpty ( )

Definition at line 691 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ IsFull()

virtual bool Barotrauma.Inventory.IsFull ( bool takeStacksIntoAccount = false )

virtual

Is there room to put more items in the inventory. Doesn't take stacking into account by default.

Parameters

takeStacksIntoAccount If true, the inventory is not considered full if all the stacks are not full.

Reimplemented in Barotrauma.ItemInventory.

Definition at line 705 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ IsInSlot()

bool Barotrauma.Inventory.IsInSlot	(	Item	item,
		int	index
	)

Definition at line 1069 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ ItemOwnsSelf()

virtual bool Barotrauma.Inventory.ItemOwnsSelf ( Item item )

virtual

Returns true if the item owns any of the parent inventories.

Definition at line 453 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ LastOrDefault()

Item Barotrauma.Inventory.LastOrDefault ( )

Return the last item in the inventory, or null if the inventory is empty.

Definition at line 390 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ PutItem()

virtual void Barotrauma.Inventory.PutItem	(	Item	item,
		int	i,
		Character	user,
		bool	removeItem = `true`,
		bool	createNetworkEvent = `true`
	)

protectedvirtual

Reimplemented in Barotrauma.CharacterInventory.

Definition at line 610 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ RemoveItem()

virtual void Barotrauma.Inventory.RemoveItem ( Item item )

virtual

Reimplemented in Barotrauma.ItemInventory, and Barotrauma.CharacterInventory.

Definition at line 1022 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ ServerEventRead()

void Barotrauma.Inventory.ServerEventRead	(	IReadMessage	msg,
		Client	c
	)

Implements Barotrauma.Networking.IClientSerializable.

Definition at line 14 of file BarotraumaServer/ServerSource/Items/Inventory.cs.

◆ SharedRead()

void Barotrauma.Inventory.SharedRead	(	IReadMessage	msg,
		List< ushort >[]	receivedItemIds,
		out bool	readyToApply
	)

Definition at line 1075 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ SharedWrite()

void Barotrauma.Inventory.SharedWrite	(	IWriteMessage	msg,
		Range	slotRange
	)

Definition at line 1106 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ TryPutItem() [1/2]

virtual bool Barotrauma.Inventory.TryPutItem	(	Item	item,
		Character	user,
		IEnumerable< InvSlotType >	allowedSlots = `null`,
		bool	createNetworkEvent = `true`,
		bool	ignoreCondition = `false`
	)

virtual

If there is room, puts the item in the inventory and returns true, otherwise returns false

Reimplemented in Barotrauma.ItemInventory, and Barotrauma.CharacterInventory.

Definition at line 537 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ TryPutItem() [2/2]

virtual bool Barotrauma.Inventory.TryPutItem	(	Item	item,
		int	i,
		bool	allowSwapping,
		bool	allowCombine,
		Character	user,
		bool	createNetworkEvent = `true`,
		bool	ignoreCondition = `false`
	)

virtual

Reimplemented in Barotrauma.CharacterInventory, and Barotrauma.ItemInventory.

Definition at line 546 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ TrySwapping()

bool Barotrauma.Inventory.TrySwapping	(	int	index,
		Item	item,
		Character	user,
		bool	createNetworkEvent,
		bool	swapWholeStack
	)

protected

Definition at line 727 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

Member Data Documentation

◆ AllowSwappingContainedItems

bool Barotrauma.Inventory.AllowSwappingContainedItems = true

Definition at line 278 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ capacity

readonly int Barotrauma.Inventory.capacity

protected

Definition at line 231 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ Locked

bool Barotrauma.Inventory.Locked

Definition at line 234 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ MaxItemsPerNetworkEvent

const int Barotrauma.Inventory.MaxItemsPerNetworkEvent = 128

static

Definition at line 15 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ MaxPossibleStackSize

const int Barotrauma.Inventory.MaxPossibleStackSize = (1 << 6) - 1

static

Definition at line 13 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ Owner

readonly Entity Barotrauma.Inventory.Owner

Definition at line 229 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ slots

readonly ItemSlot [] Barotrauma.Inventory.slots

protected

Definition at line 232 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ syncItemsDelay

float Barotrauma.Inventory.syncItemsDelay

protected

Definition at line 236 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

Property Documentation

◆ AllItems

virtual IEnumerable<Item> Barotrauma.Inventory.AllItems

get

All items contained in the inventory. Stacked items are returned as individual instances. DO NOT modify the contents of the inventory while enumerating this list.

Definition at line 249 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ AllItemsMod

IEnumerable<Item> Barotrauma.Inventory.AllItemsMod

get

All items contained in the inventory. Allows modifying the contents of the inventory while being enumerated.

Definition at line 261 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ Capacity

int Barotrauma.Inventory.Capacity

get

Definition at line 271 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ EmptySlotCount

int Barotrauma.Inventory.EmptySlotCount

get

Definition at line 276 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

◆ ExtraStackSize

int Barotrauma.Inventory.ExtraStackSize

getset

Definition at line 240 of file BarotraumaShared/SharedSource/Items/Inventory.cs.

Classes

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Inventory()

Member Function Documentation

◆ CanBePut() [1/2]

◆ CanBePut() [2/2]

◆ CanBePutInSlot() [1/2]

◆ CanBePutInSlot() [2/2]

◆ Contains()

◆ CreateNetworkEvent() [1/2]

◆ CreateNetworkEvent() [2/2]

◆ DeleteAllItems()

◆ FindAllItems()

◆ FindAllowedSlot()

◆ FindIndex()

◆ FindIndices()

◆ FindItem()

◆ FindItemByIdentifier()

◆ FindItemByTag()

◆ FirstOrDefault()

◆ ForceRemoveFromSlot()

◆ ForceToSlot()

◆ GetAllItems()

◆ GetItemAt()

◆ GetItemsAt()

◆ GetItemStackSlotIndex()

◆ HowManyCanBePut() [1/2]

◆ HowManyCanBePut() [2/2]

◆ IsEmpty()

◆ IsFull()

◆ IsInSlot()

◆ ItemOwnsSelf()

◆ LastOrDefault()

◆ PutItem()

◆ RemoveItem()

◆ ServerEventRead()

◆ SharedRead()

◆ SharedWrite()

◆ TryPutItem() [1/2]

◆ TryPutItem() [2/2]

◆ TrySwapping()

Member Data Documentation

◆ AllowSwappingContainedItems

◆ capacity

◆ Locked

◆ MaxItemsPerNetworkEvent

◆ MaxPossibleStackSize

◆ Owner

◆ slots

◆ syncItemsDelay

Property Documentation

◆ AllItems

◆ AllItemsMod

◆ Capacity

◆ EmptySlotCount

◆ ExtraStackSize