Barotrauma.ItemInventory Class Reference

Inheritance diagram for Barotrauma.ItemInventory:

Public Member Functions
	ItemInventory (Item owner, ItemContainer container, int capacity, int slotsPerRow=5)
override int	FindAllowedSlot (Item item, bool ignoreCondition=false)
override bool	CanBePutInSlot (Item item, int i, bool ignoreCondition=false)
	Can the item be put in the specified slot.
override bool	CanBePutInSlot (ItemPrefab itemPrefab, int i, float? condition, int? quality=null)
override int	HowManyCanBePut (ItemPrefab itemPrefab, int i, float? condition, bool ignoreItemsInSlot=false)
override bool	IsFull (bool takeStacksIntoAccount=false)
	Is there room to put more items in the inventory. Doesn't take stacking into account by default.
override 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.
override bool	TryPutItem (Item item, int i, bool allowSwapping, bool allowCombine, Character user, bool createNetworkEvent=true, bool ignoreCondition=false)
override void	RemoveItem (Item item)
Public Member Functions inherited from Barotrauma.Inventory
	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.
Item	FirstOrDefault ()
	Return the first item in the inventory, or null if the inventory is empty.
Item	LastOrDefault ()
	Return the last item in the inventory, or null if the inventory is empty.
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.
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.
int	GetItemStackSlotIndex (Item item, int index)
int	FindIndex (Item item)
	Find the index of the first slot the item is contained in.
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.
virtual bool	ItemOwnsSelf (Item item)
	Returns true if the item owns any of the parent inventories.
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).
bool	CanBePut (ItemPrefab itemPrefab, float? condition=null, int? quality=null)
int	HowManyCanBePut (ItemPrefab itemPrefab, float? condition=null)
bool	IsEmpty ()
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)
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!
void	ForceRemoveFromSlot (Item item, int index)
	Removes an item from a specific slot. Doesn't do any sanity checks, use with caution!
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)

Protected Member Functions
override void	CreateNetworkEvent (Range slotRange)
Protected Member Functions inherited from Barotrauma.Inventory
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)

Properties
ItemContainer	Container [get]
Properties inherited from Barotrauma.Inventory
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.
IEnumerable< Item >	AllItemsMod [get]
	All items contained in the inventory. Allows modifying the contents of the inventory while being enumerated.
int	Capacity [get]
static bool	IsDragAndDropGiveAllowed [get]
int	EmptySlotCount [get]

Additional Inherited Members
Public Attributes inherited from Barotrauma.Inventory
readonly Entity	Owner
bool	Locked
bool	AllowSwappingContainedItems = true
Static Public Attributes inherited from Barotrauma.Inventory
const int	MaxPossibleStackSize = (1 << 6) - 1
const int	MaxItemsPerNetworkEvent = 128
Protected Attributes inherited from Barotrauma.Inventory
readonly int	capacity
	Capacity, or the number of slots in the inventory.
readonly ItemSlot[]	slots
float	syncItemsDelay

Constructor & Destructor Documentation

ItemInventory()

Barotrauma.ItemInventory.ItemInventory	(	Item	owner,
		ItemContainer	container,
		int	capacity,
		int	slotsPerRow = 5 )

Member Function Documentation

CanBePutInSlot() [1/2]

override bool Barotrauma.ItemInventory.CanBePutInSlot ( Item item, int i, bool ignoreCondition = false )

virtual

Can the item be put in the specified slot.

Reimplemented from Barotrauma.Inventory.

CanBePutInSlot() [2/2]

override bool Barotrauma.ItemInventory.CanBePutInSlot ( ItemPrefab itemPrefab, int i, float? condition, int? quality = null )

virtual

Reimplemented from Barotrauma.Inventory.

CreateNetworkEvent()

override void Barotrauma.ItemInventory.CreateNetworkEvent ( Range slotRange )

protectedvirtual

Reimplemented from Barotrauma.Inventory.

FindAllowedSlot()

override int Barotrauma.ItemInventory.FindAllowedSlot ( Item item, bool ignoreCondition = false )

virtual

Reimplemented from Barotrauma.Inventory.

HowManyCanBePut()

override int Barotrauma.ItemInventory.HowManyCanBePut ( ItemPrefab itemPrefab, int i, float? condition, bool ignoreItemsInSlot = false )

virtual

Reimplemented from Barotrauma.Inventory.

IsFull()

override bool Barotrauma.ItemInventory.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 from Barotrauma.Inventory.

RemoveItem()

override void Barotrauma.ItemInventory.RemoveItem ( Item item )

virtual

Reimplemented from Barotrauma.Inventory.

TryPutItem() [1/2]

override bool Barotrauma.ItemInventory.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 from Barotrauma.Inventory.

TryPutItem() [2/2]

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

virtual

Reimplemented from Barotrauma.Inventory.

Property Documentation

Container

ItemContainer Barotrauma.ItemInventory.Container

get

---

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

• /home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaShared/SharedSource/Items/ItemInventory.cs