Inheritance diagram for AC.RuntimeInventory:

Public Member Functions
void	OnInitPersistentEngine ()
void	SetNull ()
void	SelectItemByID (int _id, SelectItemMode _mode=SelectItemMode.Use, bool ignoreInventory=false)
	Selects an inventory item (InvItem) by referencing its ID number.
void	ReselectLastItem ()
	Re-selects the last-selected inventory item, if available.
void	SelectItem (InvInstance invInstance, SelectItemMode _mode=SelectItemMode.Use)
	Selects an inventory item (InvItem)
void	Replace (int _addID, int _removeID, int addAmount=1)
	Replaces one inventory item carried by the player with another, retaining its position in its MenuInventoryBox element.
void	Add (int itemID, int amount=1, bool selectAfter=false, int playerID=-1, bool addToFront=false)
	Adds an inventory item to the player's inventory.
void	Add (InvInstance newInstance, bool selectAfter=false, int playerID=-1, bool addToFront=false)
	Adds an inventory item to the player's inventory.
void	Remove (int _id)
	Removes an inventory item from the player's inventory. If multiple instances of the item can be held, all instances will be removed.
void	Remove (InvInstance invInstance)
void	Remove (int _id, int amount)
	Removes some instances of an inventory items from the player's inventory.
void	AddToOtherPlayer (InvInstance invInstance, int playerID, bool addToFront)
void	RemoveFromOtherPlayer (int itemID, int playerID)
	Removes an inventory item from a player's inventory. If multiple instances of the item can be held, all instances will be removed.
void	RemoveFromOtherPlayer (int itemID, int amount, int playerID)
	Removes some instances of an inventory item from a player's inventory.
void	RemoveAllFromOtherPlayer (int playerID)
	Removes all items from a player's inventory.
void	RemoveAllFromOtherPlayer (int playerID, int categoryID)
	Removes all items in a category from a player's inventory.
void	Remove (string _name, int amount=0)
	Removes an inventory item from the player's inventory.
void	RemoveAll ()
	Removes all items from the player's inventory.
int	GetCount (int _invID)
	Gets the amount of a particular inventory item within the player's inventory.
int	GetCount (int _invID, int _playerID)
	Gets the amount of a particular inventory item within any player's inventory, if multiple Player prefabs are supported.
int	GetCountFromAllPlayers (int _invID)
	Gets the amount of a particular inventory item within all player inventories, if multiple Player prefabs are supported.
int	GetNumberOfItemsCarried (bool includeMultipleInSameSlot=false)
	Gets the total number of inventory items currently held by the active Player.
int	GetNumberOfItemsCarried (int _playerID, bool includeMultipleInSameSlot=false)
	Gets the total number of inventory items currently held by a given Player, if multiple Players are supported.
int	GetNumberOfItemsCarriedByAllPlayers (bool includeMultipleInSameSlot=false)
	Gets the total number of inventory items currently held by all Players, if multiple Players are supported.
int	GetNumberOfItemsCarriedInCategory (int categoryID, bool includeMultipleInSameSlot=false)
	Gets the total number of inventory items currently held by the active Player.
int	GetNumberOfItemsCarriedInCategory (int categoryID, int _playerID, bool includeMultipleInSameSlot=false)
	Gets the total number of inventory items currently held by a given Player, if multiple Players are supported.
int	GetNumberOfItemsCarriedInCategoryByAllPlayers (int categoryID, bool includeMultipleInSameSlot=false)
	Gets the total number of inventory items currently held by all Players, if multiple Players are supported.
InvInstance	GetInstance (int _id)
	Gets an inventory item instance within the player's current inventory.
InvItem	GetItem (int _id)
	Gets an inventory item within the player's current inventory.
InvItem	GetItem (string _name)
	Gets the first-found inventory item within the player's current inventory.
InvInstance	GetInstance (string _name)
	Gets the first-found instance of an inventory item within the player's current inventory.
InvInstance[]	GetInstances (int _id)
	Gets all instances of an inventory item within the player's current inventory.
InvInstance[]	GetInstances (string _name)
	Gets all instances of an inventory item within the player's current inventory.
bool	IsCarryingItem (int itemID)
	Checks if an inventory item is within the player's current inventory.
bool	IsCarryingItem (InvItem invItem)
	Checks if an inventory item is within the player's current inventory.
bool	IsCarryingItem (InvInstance invInstance)
void	ShowInteractions (InvInstance invInstance)
	Sets up all "Interaction" menus according to a specific inventory item.
void	SetHoverItem (InvInstance invInstance, MenuInventoryBox menuInventoryBox)
	Sets the item currently being hovered over by the mouse cursor.
void	SetHoverItem (InvInstance invInstance, MenuCrafting menuCrafting)
	Sets the item currently being hovered over by the mouse cursor.
void	ClearHoverItem ()
void	RemoveRecipes ()
void	RemoveRecipe (string menuName, string craftingIngredientsName)
	Resets the inventory associated with a specific Crafting Ingredients element.
Recipe	CalculateRecipe (InvCollection ingredientsInvCollection, int[] limitToCategoryIDs=null)
	Works out which Recipe, if any, for which all ingredients have been correctly arranged.
void	PerformCrafting (InvCollection ingredientsInvCollection, Recipe recipe, bool selectAfter)
	Crafts a new inventory item, and removes the relevent ingredients, according to a Recipe.
InvInstance	PerformCrafting (InvCollection ingredientsInvCollection, Recipe recipe, InvCollection toInvCollection=null)
	Crafts a new inventory item, and removes the relevent ingredients, according to a Recipe.
List< InvInstance >	RemoveEmptySlots (List< InvInstance > invInstances)
InvCollection	GetIngredientsInvCollection (string menuName, string craftingElementName)
	Gets an InvCollection of ingredients associated with a given MenuCrafting element.
void	AssignPlayerInventory (InvCollection invCollection)
	Assign's the player's current inventory in bulk.
void	DrawHighlighted (Rect _rect)
	Draws the currently-highlight item across a set region of the screen.
void	HighlightItemOnInstant (int _id)
	Fully highlights an inventory item instantly.
void	HighlightItemOffInstant ()
void	HighlightItem (int _id, HighlightType _type)
	Highlights an inventory item.
void	HighlightItem (InvInstance invInstance, HighlightType _type)
	Highlights an inventory item instance.
virtual void	DrawSelectedInventoryCount ()
bool	ProcessInventoryBoxClick (AC.Menu _menu, MenuInventoryBox inventoryBox, int _slot, MouseState _mouseState)
	Processes the clicking of an inventory item within a MenuInventoryBox element.
MainData	SaveMainData (MainData mainData)
	Updates a MainData class with its own variables that need saving.
void	LoadMainData (MainData mainData)
virtual bool	CanTransferContainerItemsToInventory (Container container, InvInstance invInstance)
	Checks if an item can be transferred from a Container to the current Player's inventory.
void	OnInitialiseScene ()

Protected Member Functions
void	OnApplicationQuit ()
void	OnEnable ()
void	OnDisable ()
virtual string	GetInventoryCountText ()
void	OnInventoryInteract (InvItem invItem, int cursorID)
void	OnInventoryCombine (InvItem invItemA, InvItem invItemB)
void	OnUpdatePlayableScreenArea ()
void	AssignStartingItems ()
InvCollection	GetItemsOnStart (int playerID=-1)
void	RemoveFromOtherPlayer (int invID, int amount, bool setAmount, int playerID)
List< InvInstance >	ReorderItems (List< InvInstance > invInstances)

Protected Attributes
InvCollection	playerInvCollection = new InvCollection ()
List< IngredientCollection >	ingredientCollections = new List<IngredientCollection> ()
InvInstance	selectedInstance = null
InvInstance	lastSelectedInstance = null
InvInstance	hoverInstance = null
InvInstance	highlightInstance = null
bool	showHoverLabel = true
InvInstance	lastClickedInstance
GUIStyle	countStyle = new GUIStyle ()
TextEffects	countTextEffects
HighlightState	highlightState = HighlightState.None
float	pulse = 0f
int	pulseDirection = 0

Properties
InvInstance	SelectedInstance `[get]`
InvItem	SelectedItem `[get]`
InvInstance	HighlightInstance `[get]`
List< InvItem >	localItems `[get]`
InvCollection[]	CraftingInvCollections `[get]`
InvCollection	PlayerInvCollection `[get]`
InvItem	hoverItem `[get]`
InvInstance	HoverInstance `[get]`
InvInstance	LastSelectedInstance `[get]`
InvInstance	LastClickedInstance `[get, set]`
InvItem	LastClickedItem `[get]`
InvItem	LastSelectedItem `[get]`
bool	ShowHoverLabel `[get]`

Detailed Description

This component is where inventory items (see InvItem) are stored at runtime. When the player aquires an item, it is transferred here (into _localItems) from the InventoryManager asset. It should be placed on the PersistentEngine prefab.

Member Function Documentation

◆ Add() [1/2]

void AC.RuntimeInventory.Add	(	int	itemID,
		int	amount = 1,
		bool	selectAfter = false,
		int	playerID = -1,
		bool	addToFront = false )

Adds an inventory item to the player's inventory.

Parameters

itemID	The ID of the inventory item to add
amount	The number of instances of the item to add
selectAfter	If True, then the inventory item will be automatically selected
playerID	The ID number of the Player to receive the item, if multiple Player prefabs are supported. If playerID = -1, the current player will receive the item
addToFront	If True, the new item will be added to the front of the inventory

◆ Add() [2/2]

void AC.RuntimeInventory.Add	(	InvInstance	newInstance,
		bool	selectAfter = false,
		int	playerID = -1,
		bool	addToFront = false )

Adds an inventory item to the player's inventory.

Parameters

newInstance	The instance of the inventory item to add
selectAfter	If True, then the inventory item will be automatically selected
playerID	The ID number of the Player to receive the item, if multiple Player prefabs are supported. If playerID = -1, the current player will receive the item
addToFront	If True, the new item will be added to the front of the inventory

◆ AssignPlayerInventory()

void AC.RuntimeInventory.AssignPlayerInventory ( InvCollection invCollection )

Assign's the player's current inventory in bulk.

Parameters

newInventory A list of the InvInstance classes that make up the new inventory

◆ CalculateRecipe()

Recipe AC.RuntimeInventory.CalculateRecipe	(	InvCollection	ingredientsInvCollection,
		int[]	limitToCategoryIDs = null )

Works out which Recipe, if any, for which all ingredients have been correctly arranged.

Parameters

ingredientsInvCollection	The InvCollection to get ingredients from
limitToCategoryIDs	If set, an array of item categories that the resulting item must be within for the recipe to be valid

Returns: The Recipe, if any, for which all ingredients have been correctly arranged

◆ CanTransferContainerItemsToInventory()

virtual bool AC.RuntimeInventory.CanTransferContainerItemsToInventory	(	Container	container,
		InvInstance	invInstance )

virtual

Checks if an item can be transferred from a Container to the current Player's inventory.

Parameters

container	The Container to transfer from
invInstance	The inventory item to to transfer

Returns: True if the item can be tranferred. This is always True, provided containerItem is not null, but the method can be overridden through subclassing

◆ ClearHoverItem()

void AC.RuntimeInventory.ClearHoverItem ( )

Clears the item being hovered

◆ DrawHighlighted()

void AC.RuntimeInventory.DrawHighlighted ( Rect _rect )

Draws the currently-highlight item across a set region of the screen.

Parameters

_rect The Screen-Space co-ordinates at which to draw the highlight item

◆ DrawSelectedInventoryCount()

virtual void AC.RuntimeInventory.DrawSelectedInventoryCount ( )

virtual

Draws how much of the selected item are selected, if greater than one. This should be called within an OnGUI function.

◆ GetCount() [1/2]

int AC.RuntimeInventory.GetCount ( int _invID )

Gets the amount of a particular inventory item within the player's inventory.

Parameters

_invID The ID number of the inventory item (InvItem) in question

Returns: The amount of the inventory item within the player's inventory.

◆ GetCount() [2/2]

int AC.RuntimeInventory.GetCount	(	int	_invID,
		int	_playerID )

Gets the amount of a particular inventory item within any player's inventory, if multiple Player prefabs are supported.

Parameters

_invID	The ID number of the inventory item (InvItem) in question
playerID	The ID number of the Player to refer to

Returns: The amount of the inventory item within the player's inventory.

◆ GetCountFromAllPlayers()

int AC.RuntimeInventory.GetCountFromAllPlayers ( int _invID )

Gets the amount of a particular inventory item within all player inventories, if multiple Player prefabs are supported.

Parameters

_invID	The ID number of the inventory item (InvItem) in question
playerID	The ID number of the Player to refer to

Returns: The amount of the inventory item within all player inventories.

◆ GetIngredientsInvCollection()

InvCollection AC.RuntimeInventory.GetIngredientsInvCollection	(	string	menuName,
		string	craftingElementName )

Gets an InvCollection of ingredients associated with a given MenuCrafting element.

Parameters

menuName	The title of the Menu that contains the MenuCrafting element
craftingElementName	The title of the "Ingredients" MenuCrafting element

Returns: The InvCollection of ingredients associated with the MenuCrafting element

◆ GetInstance() [1/2]

InvInstance AC.RuntimeInventory.GetInstance ( int _id )

Gets an inventory item instance within the player's current inventory.

Parameters

_id	The ID number of the inventory item

Returns: The inventory item, if it is held by the player

◆ GetInstance() [2/2]

InvInstance AC.RuntimeInventory.GetInstance ( string _name )

Gets the first-found instance of an inventory item within the player's current inventory.

Parameters

_name The name of the InvItem to find

Returns: The inventory item, if it is held by the player

◆ GetInstances() [1/2]

InvInstance[] AC.RuntimeInventory.GetInstances ( int _id )

Gets all instances of an inventory item within the player's current inventory.

Parameters

_id	The ID number of the InvItem to find

Returns: All instances of the inventory item

◆ GetInstances() [2/2]

InvInstance[] AC.RuntimeInventory.GetInstances ( string _name )

Gets all instances of an inventory item within the player's current inventory.

Parameters

_name The name of the InvItem to find

Returns: All instances of the inventory item

◆ GetItem() [1/2]

InvItem AC.RuntimeInventory.GetItem ( int _id )

Gets an inventory item within the player's current inventory.

Parameters

_id	The ID number of the inventory item

Returns: The inventory item, if it is held by the player

◆ GetItem() [2/2]

InvItem AC.RuntimeInventory.GetItem ( string _name )

Gets the first-found inventory item within the player's current inventory.

Parameters

_name The name of the InvItem to find

Returns: The inventory item, if it is held by the player

◆ GetNumberOfItemsCarried() [1/2]

int AC.RuntimeInventory.GetNumberOfItemsCarried ( bool includeMultipleInSameSlot = false )

Gets the total number of inventory items currently held by the active Player.

Parameters

includeMultipleInSameSlot If True, then multiple items in the same slot will be counted separately

Returns: The total number of inventory items currently held by the active Player

◆ GetNumberOfItemsCarried() [2/2]

int AC.RuntimeInventory.GetNumberOfItemsCarried	(	int	_playerID,
		bool	includeMultipleInSameSlot = false )

Gets the total number of inventory items currently held by a given Player, if multiple Players are supported.

Parameters

playerID	The ID number of the Player to refer to
includeMultipleInSameSlot	If True, then multiple items in the same slot will be counted separately

Returns: The total number of inventory items currently held by the given Player

◆ GetNumberOfItemsCarriedByAllPlayers()

int AC.RuntimeInventory.GetNumberOfItemsCarriedByAllPlayers ( bool includeMultipleInSameSlot = false )

Gets the total number of inventory items currently held by all Players, if multiple Players are supported.

Parameters

includeMultipleInSameSlot If True, then multiple items in the same slot will be counted separately

Returns: The total number of inventory items currently held by all Players

◆ GetNumberOfItemsCarriedInCategory() [1/2]

int AC.RuntimeInventory.GetNumberOfItemsCarriedInCategory	(	int	categoryID,
		bool	includeMultipleInSameSlot = false )

Gets the total number of inventory items currently held by the active Player.

Parameters

categoryID If >=0, then only items placed in the category with that ID will be counted

Returns: The total number of inventory items currently held by the active Player

◆ GetNumberOfItemsCarriedInCategory() [2/2]

int AC.RuntimeInventory.GetNumberOfItemsCarriedInCategory	(	int	categoryID,
		int	_playerID,
		bool	includeMultipleInSameSlot = false )

Gets the total number of inventory items currently held by a given Player, if multiple Players are supported.

Parameters

categoryID	If >=0, then only items placed in the category with that ID will be counted
playerID	The ID number of the Player to refer to

Returns: The total number of inventory items currently held by the given Player

◆ GetNumberOfItemsCarriedInCategoryByAllPlayers()

int AC.RuntimeInventory.GetNumberOfItemsCarriedInCategoryByAllPlayers	(	int	categoryID,
		bool	includeMultipleInSameSlot = false )

Gets the total number of inventory items currently held by all Players, if multiple Players are supported.

Parameters

categoryID If >=0, then only items placed in the category with that ID will be counted

Returns: The total number of inventory items currently held by the all Players

◆ HighlightItem() [1/2]

void AC.RuntimeInventory.HighlightItem	(	int	_id,
		HighlightType	_type )

Highlights an inventory item.

Parameters

_id	The ID number of the inventory item to highlight
_type	The type of highlighting effect to perform (Enable, Disable, PulseOnce, PulseContinuously)

◆ HighlightItem() [2/2]

void AC.RuntimeInventory.HighlightItem	(	InvInstance	invInstance,
		HighlightType	_type )

Highlights an inventory item instance.

Parameters

invInstance	The inventory item instance to highlight
_type	The type of highlighting effect to perform (Enable, Disable, PulseOnce, PulseContinuously)

◆ HighlightItemOffInstant()

void AC.RuntimeInventory.HighlightItemOffInstant ( )

Removes all highlighting from the inventory item curently being highlighted.

◆ HighlightItemOnInstant()

void AC.RuntimeInventory.HighlightItemOnInstant ( int _id )

Fully highlights an inventory item instantly.

Parameters

_id	The ID number of the inventory item (see InvItem) to highlight

◆ IsCarryingItem() [1/2]

bool AC.RuntimeInventory.IsCarryingItem ( int itemID )

Checks if an inventory item is within the player's current inventory.

Parameters

itemID The ID number of the inventory item

Returns: True if the inventory item is within the player's current inventory

◆ IsCarryingItem() [2/2]

bool AC.RuntimeInventory.IsCarryingItem ( InvItem invItem )

Checks if an inventory item is within the player's current inventory.

Parameters

invItem The inventory item

Returns: True if the inventory item is within the player's current inventory

◆ OnInitPersistentEngine()

void AC.RuntimeInventory.OnInitPersistentEngine ( )

Transfers any relevant data from InventoryManager when the game begins or restarts.

◆ PerformCrafting() [1/2]

void AC.RuntimeInventory.PerformCrafting	(	InvCollection	ingredientsInvCollection,
		Recipe	recipe,
		bool	selectAfter )

Crafts a new inventory item, and removes the relevent ingredients, according to a Recipe.

Parameters

ingredientsInvCollection	The InvCollection to get ingredients from
recipe	The Recipe to perform
selectAfter	If True, then the resulting inventory item will be selected once the crafting is complete

◆ PerformCrafting() [2/2]

InvInstance AC.RuntimeInventory.PerformCrafting	(	InvCollection	ingredientsInvCollection,
		Recipe	recipe,
		InvCollection	toInvCollection = null )

Crafts a new inventory item, and removes the relevent ingredients, according to a Recipe.

Parameters

ingredientsInvCollection	The InvCollection to get ingredients from
recipe	The Recipe to perform
toInvCollection	If assigned, the InvCollection to place the newly-created Recipe item into

◆ ProcessInventoryBoxClick()

bool AC.RuntimeInventory.ProcessInventoryBoxClick	(	AC.Menu	_menu,
		MenuInventoryBox	inventoryBox,
		int	_slot,
		MouseState	_mouseState )

Processes the clicking of an inventory item within a MenuInventoryBox element.

Parameters

_menu	The Menu that contains the MenuInventoryBox element
inventoryBox	The MenuInventoryBox element that was clicked on
_slot	The index number of the MenuInventoryBox slot that was clicked on
_mouseState	The state of the mouse when the click occured (Normal, SingleClick, RightClick, DoubleClick, HeldDown, LetGo)

Returns: True if the click had an effect and should be consumed

◆ Remove() [1/3]

void AC.RuntimeInventory.Remove ( int _id )

Removes an inventory item from the player's inventory. If multiple instances of the item can be held, all instances will be removed.

Parameters

_id	The ID number of the inventory item (InvItem) to remove

◆ Remove() [2/3]

void AC.RuntimeInventory.Remove	(	int	_id,
		int	amount )

Removes some instances of an inventory items from the player's inventory.

Parameters

_id	The ID number of the inventory item (InvItem) to remove
amount	The amount if the inventory item to remove, if the InvItem's canCarryMultiple = True

◆ Remove() [3/3]

void AC.RuntimeInventory.Remove	(	string	_name,
		int	amount = 0 )

Removes an inventory item from the player's inventory.

Parameters

_name	The name of the item to remove
amount	If >0, then only that quantity will be removed, if the item's canCarryMultiple property is True. Otherwise, all instances will be removed

◆ RemoveAllFromOtherPlayer() [1/2]

void AC.RuntimeInventory.RemoveAllFromOtherPlayer ( int playerID )

Removes all items from a player's inventory.

Parameters

playerID The ID number of the player to affect

◆ RemoveAllFromOtherPlayer() [2/2]

void AC.RuntimeInventory.RemoveAllFromOtherPlayer	(	int	playerID,
		int	categoryID )

Removes all items in a category from a player's inventory.

Parameters

playerID	The ID number of the player to affect
categoryID	The ID of the category

◆ RemoveFromOtherPlayer() [1/2]

void AC.RuntimeInventory.RemoveFromOtherPlayer	(	int	itemID,
		int	amount,
		int	playerID )

Removes some instances of an inventory item from a player's inventory.

Parameters

itemID	The ID number of the inventory item (InvItem) to remove
amount	The amount if the inventory item to remove, if the InvItem's canCarryMultiple = True.
playerID	The ID number of the player to affect, if player-switching is enabled

◆ RemoveFromOtherPlayer() [2/2]

void AC.RuntimeInventory.RemoveFromOtherPlayer	(	int	itemID,
		int	playerID )

Removes an inventory item from a player's inventory. If multiple instances of the item can be held, all instances will be removed.

Parameters

itemID	The ID number of the inventory item (InvItem) to remove
playerID	The ID number of the player to affect, if player-switching is enabled

◆ RemoveRecipe()

void AC.RuntimeInventory.RemoveRecipe	(	string	menuName,
		string	craftingIngredientsName )

Resets the inventory associated with a specific Crafting Ingredients element.

Parameters

menuName	The name of the Menu
craftingIngredientsName	The name of the Crafting menu element of type Ingredients

◆ RemoveRecipes()

void AC.RuntimeInventory.RemoveRecipes ( )

Resets all active recipes, and clears all MenuCrafting elements

◆ Replace()

void AC.RuntimeInventory.Replace	(	int	_addID,
		int	_removeID,
		int	addAmount = 1 )

Replaces one inventory item carried by the player with another, retaining its position in its MenuInventoryBox element.

Parameters

_addID	The ID number of the inventory item (InvItem) to add
_removeID	The ID number of the inventory item (InvItem) to remove
addAmount	The amount if the new inventory item to add, if the InvItem's canCarryMultiple = True

◆ SaveMainData()

MainData AC.RuntimeInventory.SaveMainData ( MainData mainData )

Updates a MainData class with its own variables that need saving.

Parameters

mainData The original MainData class

Returns: The updated MainData class

◆ SelectItem()

void AC.RuntimeInventory.SelectItem	(	InvInstance	invInstance,
		SelectItemMode	_mode = SelectItemMode::Use )

Selects an inventory item (InvItem)

Parameters

invInstance	The instance of the inventory item to select
_mode	What mode the item is selected in (Use, Give)

◆ SelectItemByID()

void AC.RuntimeInventory.SelectItemByID	(	int	_id,
		SelectItemMode	_mode = SelectItemMode::Use,
		bool	ignoreInventory = false )

Selects an inventory item (InvItem) by referencing its ID number.

Parameters

_id	The inventory item's ID number
_mode	What mode the item is selected in (Use, Give)

◆ SetHoverItem() [1/2]

void AC.RuntimeInventory.SetHoverItem	(	InvInstance	invInstance,
		MenuCrafting	menuCrafting )

Sets the item currently being hovered over by the mouse cursor.

Parameters

invInstance	The instance of the item to set
menuCrafting	The MenuInventoryBox that the item is displayed within

◆ SetHoverItem() [2/2]

void AC.RuntimeInventory.SetHoverItem	(	InvInstance	invInstance,
		MenuInventoryBox	menuInventoryBox )

Sets the item currently being hovered over by the mouse cursor.

Parameters

invInstance	The instance of the item to set
menuInventoryBox	The MenuInventoryBox that the item is displayed within

◆ SetNull()

void AC.RuntimeInventory.SetNull ( )

De-selects the active inventory item.

◆ ShowInteractions()

void AC.RuntimeInventory.ShowInteractions ( InvInstance invInstance )

Sets up all "Interaction" menus according to a specific inventory item.

Parameters

invInstance The relevant inventory item instance

Property Documentation

◆ CraftingInvCollections

InvCollection [] AC.RuntimeInventory.CraftingInvCollections

get

The InvCollections that holds the current set of items to be crafted

◆ HighlightInstance

InvInstance AC.RuntimeInventory.HighlightInstance

get

The inventory item that is currently being highlighted within an MenuInventoryBox element

◆ HoverInstance

InvInstance AC.RuntimeInventory.HoverInstance

get

The instance of the inventory item that is currently being hovered over

◆ hoverItem

InvItem AC.RuntimeInventory.hoverItem

get

The inventory item that is currently being hovered over

◆ LastClickedInstance

InvInstance AC.RuntimeInventory.LastClickedInstance

getset

The instance of the last inventory item that the player clicked on, in any MenuInventoryBox element type

◆ LastClickedItem

InvItem AC.RuntimeInventory.LastClickedItem

get

The last inventory item that the player clicked on, in any MenuInventoryBox element type

◆ LastSelectedInstance

InvInstance AC.RuntimeInventory.LastSelectedInstance

get

The instance of the last inventory item to be selected. This will return the currently-selected item if one exists

◆ LastSelectedItem

InvItem AC.RuntimeInventory.LastSelectedItem

get

The last inventory item to be selected. This will return the currently-selected item if one exists

◆ localItems

List<InvItem> AC.RuntimeInventory.localItems

get

A List of inventory items carried by the player. This is calculated from LocalInstances and should not be called every frame

◆ PlayerInvCollection

InvCollection AC.RuntimeInventory.PlayerInvCollection

get

The InvCollection that holds the current set of items in the Player#s inventory

◆ SelectedInstance

InvInstance AC.RuntimeInventory.SelectedInstance

get

The instance inventory item that is currently selected

◆ SelectedItem

InvItem AC.RuntimeInventory.SelectedItem

get

The inventory item that is currently selected

◆ ShowHoverLabel

bool AC.RuntimeInventory.ShowHoverLabel

get

If True, then the Hotspot label will show the name of the inventory item that the mouse is hovering over

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ AssignPlayerInventory()

◆ CalculateRecipe()

◆ CanTransferContainerItemsToInventory()

◆ ClearHoverItem()

◆ DrawHighlighted()

◆ DrawSelectedInventoryCount()

◆ GetCount() [1/2]

◆ GetCount() [2/2]

◆ GetCountFromAllPlayers()

◆ GetIngredientsInvCollection()

◆ GetInstance() [1/2]

◆ GetInstance() [2/2]

◆ GetInstances() [1/2]

◆ GetInstances() [2/2]

◆ GetItem() [1/2]

◆ GetItem() [2/2]

◆ GetNumberOfItemsCarried() [1/2]

◆ GetNumberOfItemsCarried() [2/2]

◆ GetNumberOfItemsCarriedByAllPlayers()

◆ GetNumberOfItemsCarriedInCategory() [1/2]

◆ GetNumberOfItemsCarriedInCategory() [2/2]

◆ GetNumberOfItemsCarriedInCategoryByAllPlayers()

◆ HighlightItem() [1/2]

◆ HighlightItem() [2/2]

◆ HighlightItemOffInstant()

◆ HighlightItemOnInstant()

◆ IsCarryingItem() [1/2]

◆ IsCarryingItem() [2/2]

◆ OnInitPersistentEngine()

◆ PerformCrafting() [1/2]

◆ PerformCrafting() [2/2]

◆ ProcessInventoryBoxClick()

◆ Remove() [1/3]

◆ Remove() [2/3]

◆ Remove() [3/3]

◆ RemoveAllFromOtherPlayer() [1/2]

◆ RemoveAllFromOtherPlayer() [2/2]

◆ RemoveFromOtherPlayer() [1/2]

◆ RemoveFromOtherPlayer() [2/2]

◆ RemoveRecipe()

◆ RemoveRecipes()

◆ Replace()

◆ SaveMainData()

◆ SelectItem()

◆ SelectItemByID()

◆ SetHoverItem() [1/2]

◆ SetHoverItem() [2/2]

◆ SetNull()

◆ ShowInteractions()

Property Documentation

◆ CraftingInvCollections

◆ HighlightInstance

◆ HoverInstance

◆ hoverItem

◆ LastClickedInstance

◆ LastClickedItem

◆ LastSelectedInstance

◆ LastSelectedItem

◆ localItems

◆ PlayerInvCollection

◆ SelectedInstance

◆ SelectedItem

◆ ShowHoverLabel