Public Member Functions

InvCollection (int _maxSlots=0)

The default Constructor.

InvCollection (List< InvItem > invItems, int _maxSlots=0)

A Constructor that populates itself with default inventory data</sumary>

Parameters

invItems	A list of default items
maxSlots	If >0, the maximum number of slots

InvCollection (List< InvInstance > _invInstances, bool allowEmptySlots=false, int _maxSlots=0)

A Constructor that populates itself based on an existing list of inventory item instances.

InvCollection (Container container)

void Transfer (int invID, InvCollection fromCollection)

Transfer all counts of a given inventory item from another collection.

void Transfer (InvInstance invInstance, InvCollection fromCollection)

Transfer all counts of a given inventory item from another collection.

void Transfer (int invID, InvCollection fromCollection, int amount, bool matchPropertiesWhenMerging=true)

Transfer a set count of a given inventory item from another collection.

void Transfer (InvInstance invInstance, InvCollection fromCollection, int amount, bool matchPropertiesWhenMerging=true)

Transfer a set count of a given inventory item from another collection.

void TransferAll (InvCollection fromCollection)

Transfers all items from another collection.

InvInstance Add (InvInstance addInstance, bool matchPropertiesWhenMerging=true)

Adds an inventory item instance to the collection. If the item exists in another collection, it will be removed from there automatically.

InvInstance AddToEnd (InvInstance addInstance)

Adds an inventory item instance to the end of the collection - or the first-available empty slot. If the item exists in another collection, it will be removed from there automatically.

InvInstance Insert (InvInstance addInstance, int index, OccupiedSlotBehaviour occupiedSlotBehaviour=OccupiedSlotBehaviour.ShiftItems, bool matchPropertiesWhenMerging=true)

Inserts an inventory item instance into a specific index in the collection. If the item exists in another collection, it will be removed from there automatically.

void Delete (InvInstance invInstance)

Deletes a given inventory item instance, provided it is a part of this collection.

void Delete (InvInstance invInstance, int amount)

Deletes a given inventory item instance, provided it is a part of this collection.

void Delete (int itemID, int amount)

Deletes a set number of inventory item instances.

void Delete (string itemName, int amount)

Deletes a set number of inventory item instances.

void DeleteAtIndex (int index, int amount=-1)

Deletes a set number of inventory item instances at a given index.

void DeleteAllOfType (int itemID)

Deletes all inventory item instances associated with a given inventory item.

void DeleteAll ()

void DeleteAllInCategory (int categoryID)

Deletes all item instances in a specific category.

void DeleteRecipeIngredients (Recipe recipe)

Deletes all item instances that make up a recipe's ingredients.

int IndexOf (InvInstance invInstance)

string GetSaveData ()

InvInstance GetInstanceAtIndex (int index)

Gets the inventory item instance in the collection at a given index.

int GetInstanceIndex (InvInstance invInstance)

Gets the index that a given Inventory item instance is at in the collection.

int GetCount (int invID, bool includeMultipleInSameSlot=true)

Gets the amount of instances in the collection that represent a given inventory item.

int GetCount (string itemName, bool includeMultipleInSameSlot=true)

Gets the amount of instances in the collection that represent a given inventory item.

int GetCount (bool includeMultipleInSameSlot=true)

Gets the amount of instances in the collection.

int GetCountInCategory (int categoryID, bool includeMultipleInSameSlot=true)

Gets the amount of instances in the collection that represent an inventory item in a given category.

bool Contains (InvInstance invInstance)

bool Contains (int invID)

InvInstance GetFirstInstance (int invID)

Gets the first-found inventory item instance in the collection that's associated with a specific inventory item.

InvInstance GetFirstInstance (string invName)

Gets the first-found inventory item instance in the collection that's associated with a specific inventory item.

InvInstance[] GetAllInstances (int invID)

Gets all inventory item instance in the collection that are associated with a specific inventory item.

InvInstance[] GetAllInstances (string invName)

Gets all inventory item instance in the collection that are associated with a specific inventory item.

int GetTotalIntProperty (int propertyID)

Gets the total value of all instances of an Integer inventory property (e.g. currency) within a set of inventory items.

int GetTotalIntProperty (string propertyName)

Gets the total value of all instances of an Integer inventory property (e.g. currency) within a set of inventory items.

float GetTotalFloatProperty (int propertyID)

Gets the total value of all instances of an Float inventory property (e.g. weight) within a set of inventory items.

float GetTotalFloatProperty (string propertyName)

Gets the total value of all instances of an Float inventory property (e.g. weight) within a set of inventory items.

InvVar GetPropertyTotals (int propertyID)

Gets the total amount of given integer or float inventory property, found in the current inventory.

InvInstance[] GetInstancesInCategory (int categoryID)

Gets an array of all carried inventory items in a given category.

bool IsPlayerInventory ()

Container GetSourceContainer ()

Static Public Member Functions
static List< InvInstance >	DataToInstances (string data)
static InvCollection	LoadData (string data, Container container=null)

Properties
List< InvInstance >	InvInstances `[get]`
List< InvItem >	InvItems `[get]`
int	MaxSlots `[get, set]`

Detailed Description

This class stores a list of InvInstance (inventory item instances), and has functions to manage them.

Constructor & Destructor Documentation

◆ InvCollection() [1/3]

AC.InvCollection.InvCollection ( int _maxSlots = 0 )

The default Constructor.

Parameters

maxSlots If >0, the maximum number of slots

◆ InvCollection() [2/3]

AC.InvCollection.InvCollection	(	List< InvInstance >	_invInstances,
		bool	allowEmptySlots = false,
		int	_maxSlots = 0 )

A Constructor that populates itself based on an existing list of inventory item instances.

Parameters

_invInstances	A List of InvInstances that represent the items to be added
allowEmptySlots	If True, then invalid or empty entries in the _invInstances List will be included and used to add empty slots, rather than removed
maxSlots	If >0, the maximum number of slots

◆ InvCollection() [3/3]

AC.InvCollection.InvCollection ( Container container )

A Constructor that populates itself based on a Container's default set of items

Member Function Documentation

◆ Add()

InvInstance AC.InvCollection.Add	(	InvInstance	addInstance,
		bool	matchPropertiesWhenMerging = true )

Adds an inventory item instance to the collection. If the item exists in another collection, it will be removed from there automatically.

Parameters

addInstance The inventory item instance to add

Returns: The new instance of the added item

◆ AddToEnd()

InvInstance AC.InvCollection.AddToEnd ( InvInstance addInstance )

Adds an inventory item instance to the end of the collection - or the first-available empty slot. If the item exists in another collection, it will be removed from there automatically.

Parameters

addInstance The inventory item instance to add

Returns: The new instance of the added item

◆ Contains() [1/2]

bool AC.InvCollection.Contains ( int invID )

Checks if the collection contains an inventory instance associated with a given inventory item

◆ Contains() [2/2]

bool AC.InvCollection.Contains ( InvInstance invInstance )

Checks if the collection contains a given inventory instance

◆ Delete() [1/4]

void AC.InvCollection.Delete	(	int	itemID,
		int	amount )

Deletes a set number of inventory item instances.

Parameters

itemID	The ID of the inventory item to delete
amount	The amount to delete

◆ Delete() [2/4]

void AC.InvCollection.Delete ( InvInstance invInstance )

Deletes a given inventory item instance, provided it is a part of this collection.

Parameters

invInstance The inventory item instance to delete

◆ Delete() [3/4]

void AC.InvCollection.Delete	(	InvInstance	invInstance,
		int	amount )

Deletes a given inventory item instance, provided it is a part of this collection.

Parameters

invInstance	The inventory item instance to delete
amount	The amount to delete

◆ Delete() [4/4]

void AC.InvCollection.Delete	(	string	itemName,
		int	amount )

Deletes a set number of inventory item instances.

Parameters

itemName	The name of the inventory item to delete
amount	The amount to delete

◆ DeleteAll()

void AC.InvCollection.DeleteAll ( )

Deletes all item instances in the collection

◆ DeleteAllInCategory()

void AC.InvCollection.DeleteAllInCategory ( int categoryID )

Deletes all item instances in a specific category.

Parameters

categoryID The ID of the category to remove items from

◆ DeleteAllOfType()

void AC.InvCollection.DeleteAllOfType ( int itemID )

Deletes all inventory item instances associated with a given inventory item.

Parameters

itemID The ID of the inventory item to delete

◆ DeleteAtIndex()

void AC.InvCollection.DeleteAtIndex	(	int	index,
		int	amount = -1 )

Deletes a set number of inventory item instances at a given index.

Parameters

index	The index to delete from
amount	The amount to delete, if non-negative. Otherwise, all will be deleted

◆ DeleteRecipeIngredients()

void AC.InvCollection.DeleteRecipeIngredients ( Recipe recipe )

Deletes all item instances that make up a recipe's ingredients.

Parameters

recipe The recipe to delete ingredients from

◆ GetAllInstances() [1/2]

InvInstance[] AC.InvCollection.GetAllInstances ( int invID )

Gets all inventory item instance in the collection that are associated with a specific inventory item.

Parameters

invID The ID of the inventory item

Returns: An array of inventory item instance

◆ GetAllInstances() [2/2]

InvInstance[] AC.InvCollection.GetAllInstances ( string invName )

Gets all inventory item instance in the collection that are associated with a specific inventory item.

Parameters

invName The nameof the inventory item

Returns: An array of inventory item instance

◆ GetCount() [1/3]

int AC.InvCollection.GetCount ( bool includeMultipleInSameSlot = true )

Gets the amount of instances in the collection.

Parameters

includeMultipleInSameSlot If True, then the result will account for multiple amounts of an item in a single slot

Returns: The amount of instances in the collection

◆ GetCount() [2/3]

int AC.InvCollection.GetCount	(	int	invID,
		bool	includeMultipleInSameSlot = true )

Gets the amount of instances in the collection that represent a given inventory item.

Parameters

invID	The inventory item's ID number
includeMultipleInSameSlot	If True, then the result will account for multiple amounts of the item in a single slot

Returns: The amount of instances in the collection that represent the inventory item

◆ GetCount() [3/3]

int AC.InvCollection.GetCount	(	string	itemName,
		bool	includeMultipleInSameSlot = true )

Gets the amount of instances in the collection that represent a given inventory item.

Parameters

itemName	The inventory item's name
includeMultipleInSameSlot	If True, then the result will account for multiple amounts of the item in a single slot

Returns: The amount of instances in the collection that represent the inventory item

◆ GetCountInCategory()

int AC.InvCollection.GetCountInCategory	(	int	categoryID,
		bool	includeMultipleInSameSlot = true )

Gets the amount of instances in the collection that represent an inventory item in a given category.

Parameters

categoryID	The category's ID number.
includeMultipleInSameSlot	If True, then the result will account for multiple amounts of the item in a single slot

Returns: The amount of instances in the collection that represent inventory items in the category

◆ GetFirstInstance() [1/2]

InvInstance AC.InvCollection.GetFirstInstance ( int invID )

Gets the first-found inventory item instance in the collection that's associated with a specific inventory item.

Parameters

invID The ID number of the inventory item

Returns: The first-found inventory item instance

◆ GetFirstInstance() [2/2]

InvInstance AC.InvCollection.GetFirstInstance ( string invName )

Gets the first-found inventory item instance in the collection that's associated with a specific inventory item.

Parameters

invName The name of the inventory item

Returns: The first-found inventory item instance

◆ GetInstanceAtIndex()

InvInstance AC.InvCollection.GetInstanceAtIndex ( int index )

Gets the inventory item instance in the collection at a given index.

Parameters

index The index to get

Returns: The inventory item instance at the index

◆ GetInstanceIndex()

int AC.InvCollection.GetInstanceIndex ( InvInstance invInstance )

Gets the index that a given Inventory item instance is at in the collection.

Parameters

invInstance The Inventory item instance to get

Returns: The item instance's index in the collection, or -1 if it is not present

◆ GetInstancesInCategory()

InvInstance[] AC.InvCollection.GetInstancesInCategory ( int categoryID )

Gets an array of all carried inventory items in a given category.

Parameters

categoryID The ID number of the category in question

Returns: An array of all carried inventory items in the category

◆ GetPropertyTotals()

InvVar AC.InvCollection.GetPropertyTotals ( int propertyID )

Gets the total amount of given integer or float inventory property, found in the current inventory.

Parameters

propertyID The ID of the integer or float inventory property

Returns: The total amount of the property's value

◆ GetSaveData()

string AC.InvCollection.GetSaveData ( )

Generates a single string that represents the class's saveable data

◆ GetSourceContainer()

Container AC.InvCollection.GetSourceContainer ( )

Gets the Container that this collection represents, if appropriate

◆ GetTotalFloatProperty() [1/2]

float AC.InvCollection.GetTotalFloatProperty ( int propertyID )

Gets the total value of all instances of an Float inventory property (e.g. weight) within a set of inventory items.

Parameters

propertyID The ID number of the Inventory property (see InvVar) to get the total value of

Returns: The total value of all instances of the Float inventory property within the set of inventory items

◆ GetTotalFloatProperty() [2/2]

float AC.InvCollection.GetTotalFloatProperty ( string propertyName )

Gets the total value of all instances of an Float inventory property (e.g. weight) within a set of inventory items.

Parameters

propertyName The name of the Inventory property (see InvVar) to get the total value of

Returns: The total value of all instances of the Float inventory property within the set of inventory items

◆ GetTotalIntProperty() [1/2]

int AC.InvCollection.GetTotalIntProperty ( int propertyID )

Gets the total value of all instances of an Integer inventory property (e.g. currency) within a set of inventory items.

Parameters

propertyID The ID number of the Inventory property (see InvVar) to get the total value of

Returns: The total value of all instances of the Integer inventory property within the set of inventory items

◆ GetTotalIntProperty() [2/2]

int AC.InvCollection.GetTotalIntProperty ( string propertyName )

Gets the total value of all instances of an Integer inventory property (e.g. currency) within a set of inventory items.

Parameters

propertyName The name of the Inventory property (see InvVar) to get the total value of

Returns: The total value of all instances of the Integer inventory property within the set of inventory items

◆ IndexOf()

int AC.InvCollection.IndexOf ( InvInstance invInstance )

Gets the index of a given inventory item instance

◆ Insert()

InvInstance AC.InvCollection.Insert	(	InvInstance	addInstance,
		int	index,
		OccupiedSlotBehaviour	occupiedSlotBehaviour = OccupiedSlotBehaviour::ShiftItems,
		bool	matchPropertiesWhenMerging = true )

Inserts an inventory item instance into a specific index in the collection. If the item exists in another collection, it will be removed from there automatically.

Parameters

addInstance	The inventory item instance to add
index	The index to insert the item at
occupiedSlotBehaviour	How to react if the intended index is already occupied by another item instance.

Returns: The new instance of the added item

◆ IsPlayerInventory()

bool AC.InvCollection.IsPlayerInventory ( )

Checks if this collection represents the player's inventory

◆ LoadData()

InvCollection AC.InvCollection.LoadData	(	string	data,
		Container	container = null )

static

Create a new class instance based on a serialised data string generated by the GetSaveData function

◆ Transfer() [1/4]

void AC.InvCollection.Transfer	(	int	invID,
		InvCollection	fromCollection )

Transfer all counts of a given inventory item from another collection.

Parameters

invID	The ID of the inventory item (InvItem) to transfer
fromCollection	The collection to transfer from

◆ Transfer() [2/4]

void AC.InvCollection.Transfer	(	int	invID,
		InvCollection	fromCollection,
		int	amount,
		bool	matchPropertiesWhenMerging = true )

Transfer a set count of a given inventory item from another collection.

Parameters

invID	The ID of the inventory item (InvItem) to transfer
fromCollection	The collection to transfer from
amount	The amount of items to transfer
matchPropertiesWhenMerging	If True, then the property values of two slots that represent the same item must match for them to merge

◆ Transfer() [3/4]

void AC.InvCollection.Transfer	(	InvInstance	invInstance,
		InvCollection	fromCollection )

Transfer all counts of a given inventory item from another collection.

Parameters

invInstance	The instance of the inventory item (InvItem) to transfer
fromCollection	The collection to transfer from

◆ Transfer() [4/4]

void AC.InvCollection.Transfer	(	InvInstance	invInstance,
		InvCollection	fromCollection,
		int	amount,
		bool	matchPropertiesWhenMerging = true )

Transfer a set count of a given inventory item from another collection.

Parameters

invInstance	The instance of the inventory item to transfer
fromCollection	The collection to transfer from
amount	The amount of items to transfer
matchPropertiesWhenMerging	If True, then the property values of two slots that represent the same item must match for them to merge

◆ TransferAll()

void AC.InvCollection.TransferAll ( InvCollection fromCollection )

Transfers all items from another collection.

Parameters

fromCollection The collection of inventory item instances to transfer from

Property Documentation

◆ InvInstances

List<InvInstance> AC.InvCollection.InvInstances

get

All Inventory item instances in the collection

◆ InvItems

List<InvItem> AC.InvCollection.InvItems

get

A list of all Inventory Items represented in the collection.

◆ MaxSlots

int AC.InvCollection.MaxSlots

getset

If > 0, the maximum number of slots the collection has to store items

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ InvCollection() [1/3]

◆ InvCollection() [2/3]

◆ InvCollection() [3/3]

Member Function Documentation

◆ Add()

◆ AddToEnd()

◆ Contains() [1/2]

◆ Contains() [2/2]

◆ Delete() [1/4]

◆ Delete() [2/4]

◆ Delete() [3/4]

◆ Delete() [4/4]

◆ DeleteAll()

◆ DeleteAllInCategory()

◆ DeleteAllOfType()

◆ DeleteAtIndex()

◆ DeleteRecipeIngredients()

◆ GetAllInstances() [1/2]

◆ GetAllInstances() [2/2]

◆ GetCount() [1/3]

◆ GetCount() [2/3]

◆ GetCount() [3/3]

◆ GetCountInCategory()

◆ GetFirstInstance() [1/2]

◆ GetFirstInstance() [2/2]

◆ GetInstanceAtIndex()

◆ GetInstanceIndex()

◆ GetInstancesInCategory()

◆ GetPropertyTotals()

◆ GetSaveData()

◆ GetSourceContainer()

◆ GetTotalFloatProperty() [1/2]

◆ GetTotalFloatProperty() [2/2]

◆ GetTotalIntProperty() [1/2]

◆ GetTotalIntProperty() [2/2]

◆ IndexOf()

◆ Insert()

◆ IsPlayerInventory()

◆ LoadData()

◆ Transfer() [1/4]

◆ Transfer() [2/4]

◆ Transfer() [3/4]

◆ Transfer() [4/4]

◆ TransferAll()

Property Documentation

◆ InvInstances

◆ InvItems

◆ MaxSlots