Public Member Functions
virtual void	UseCraftingRecipe (Combatant combatant, int recipeID, NotifyBool notify)
	Creates the outcome of a crafting recipe. More...

virtual void	AddToCraftingList (Combatant combatant, IShortcut item)
	Adds an item to the crafting list of a combatant. More...

virtual void	RemoveFromCraftingList (Combatant combatant, IShortcut item)
	Removes an item from the crafting list of a combatant. More...

virtual void	ClearCraftingList (Combatant combatant)
	Removes all items in a combatant's crafting list and returns them to the inventory. More...

virtual void	CreateFromCraftingList (Combatant combatant, CraftingListCreationType creationType, bool consumeUnused, bool onlyKnownRecipes, Notify finished)
	Creates the outcome of a crafting recipe matching the items in the crafting list of a combatant. More...

virtual bool	Add (Inventory inventory, IShortcut item, bool showNotification, bool showConsole, bool markNewContent)
	Adds an item to an inventory. More...

virtual void	Remove (Inventory inventory, IShortcut item, int quantity, bool showNotification, bool showConsole)
	Removes an item from an inventory More...

virtual void	Drop (Inventory inventory, IShortcut item, int quantity, bool showNotification, bool showConsole)
	Drops an item from an inventory into the game world. More...

virtual void	SetMoney (Inventory inventory, int id, int quantity, bool showNotification, bool showConsole)
	Sets the amount of money in an inventory. More...

virtual void	AddMoney (Inventory inventory, int id, int quantity, bool showNotification, bool showConsole)
	Adds money to an inventory. More...

virtual void	SubMoney (Inventory inventory, int id, int quantity, bool showNotification, bool showConsole)
	Removes money from an inventory. More...

virtual void	RemoveItemType (Inventory inventory, int typeID, bool removeSubTypes, bool removeMoney, bool removeItems, bool removeWeapons, bool removeArmor, bool showNotification, bool showConsole)
	Removes items of an item type from an inventory. More...

virtual ShopScreen	OpenShop (IEventStarter starter, int shopID, string shopSceneID, int factionID)

Member Function Documentation

◆ Add()

virtual bool ORKFramework.InventoryAccessHandler.Add	(	Inventory	inventory,
		IShortcut	item,
		bool	showNotification,
		bool	showConsole,
		bool	markNewContent
	)

virtual

Adds an item to an inventory.

Parameters

inventory	The inventory that will be used.
item	The item that will be added.
showNotification	`true` if a notification should be displayed.
showConsole	`true` if a console line should be added.
markNewContent	`true` if the item should be marked as new content.

Returns: true if the item was added.

◆ AddMoney()

virtual void ORKFramework.InventoryAccessHandler.AddMoney	(	Inventory	inventory,
		int	id,
		int	quantity,
		bool	showNotification,
		bool	showConsole
	)

virtual

Adds money to an inventory.

Parameters

inventory	The inventory that will be used.
id	The ID/index of the currency.
quantity	The quantity that will be added.
showNotification	`true` if a notification should be displayed.
showConsole	`true` if a console line should be added.

◆ AddToCraftingList()

virtual void ORKFramework.InventoryAccessHandler.AddToCraftingList	(	Combatant	combatant,
		IShortcut	item
	)

virtual

Adds an item to the crafting list of a combatant.

Parameters

combatant	The used combatant.
item	The item that will be added.

◆ ClearCraftingList()

virtual void ORKFramework.InventoryAccessHandler.ClearCraftingList ( Combatant combatant )

virtual

Removes all items in a combatant's crafting list and returns them to the inventory.

Parameters

combatant The used combatant.

◆ CreateFromCraftingList()

virtual void ORKFramework.InventoryAccessHandler.CreateFromCraftingList	(	Combatant	combatant,
		CraftingListCreationType	creationType,
		bool	consumeUnused,
		bool	onlyKnownRecipes,
		Notify	finished
	)

virtual

Creates the outcome of a crafting recipe matching the items in the crafting list of a combatant.

Parameters

combatant	The used combatant.
creationType	The creation type used (Exact, One, Multi).
consumeUnused	`true` if unused items in the crafting list should be consumed.
onlyKnownRecipes	`true` if only crafting recipes that are known to the combatant should be used.

◆ Drop()

virtual void ORKFramework.InventoryAccessHandler.Drop	(	Inventory	inventory,
		IShortcut	item,
		int	quantity,
		bool	showNotification,
		bool	showConsole
	)

virtual

Drops an item from an inventory into the game world.

Parameters

inventory	The inventory that will be used.
item	The item that will be dropped.
quantity	The quantity that will be dropped.
showNotification	`true` if a notification should be displayed.
showConsole	`true` if a console line should be added.

◆ Remove()

virtual void ORKFramework.InventoryAccessHandler.Remove	(	Inventory	inventory,
		IShortcut	item,
		int	quantity,
		bool	showNotification,
		bool	showConsole
	)

virtual

Removes an item from an inventory

Parameters

inventory	The inventory that will be used.
item	The item that will be removed.
quantity	The quantity that will be removed.
showNotification	`true` if a notification should be displayed.
showConsole	`true` if a console line should be added.

◆ RemoveFromCraftingList()

virtual void ORKFramework.InventoryAccessHandler.RemoveFromCraftingList	(	Combatant	combatant,
		IShortcut	item
	)

virtual

Removes an item from the crafting list of a combatant.

Parameters

combatant	The used combatant.
item	The item that will be removed.

◆ RemoveItemType()

virtual void ORKFramework.InventoryAccessHandler.RemoveItemType	(	Inventory	inventory,
		int	typeID,
		bool	removeSubTypes,
		bool	removeMoney,
		bool	removeItems,
		bool	removeWeapons,
		bool	removeArmor,
		bool	showNotification,
		bool	showConsole
	)

virtual

Removes items of an item type from an inventory.

Parameters

inventory	The inventory that will be used.
typeID	The ID/index of the item type that will be removed.
removeSubTypes	`true` if sub types of the item type should be removed.
removeMoney	`true` if money should be removed.
removeItems	`true` if items should be removed.
removeWeapons	`true` if weapons should be removed.
removeArmor	`true` if armors should be removed.
showNotification	`true` if a notification should be displayed.
showConsole	`true` if a console line should be added.

◆ SetMoney()

virtual void ORKFramework.InventoryAccessHandler.SetMoney	(	Inventory	inventory,
		int	id,
		int	quantity,
		bool	showNotification,
		bool	showConsole
	)

virtual

Sets the amount of money in an inventory.

Parameters

inventory	The inventory that will be used.
id	The ID/index of the currency.
quantity	The quantity the currency will be set to.
showNotification	`true` if a notification should be displayed.
showConsole	`true` if a console line should be added.

◆ SubMoney()

virtual void ORKFramework.InventoryAccessHandler.SubMoney	(	Inventory	inventory,
		int	id,
		int	quantity,
		bool	showNotification,
		bool	showConsole
	)

virtual

Removes money from an inventory.

Parameters

inventory	The inventory that will be used.
id	The ID/index of the currency.
quantity	The quantity that will be removed.
showNotification	`true` if a notification should be displayed.
showConsole	`true` if a console line should be added.

◆ UseCraftingRecipe()

virtual void ORKFramework.InventoryAccessHandler.UseCraftingRecipe	(	Combatant	combatant,
		int	recipeID,
		NotifyBool	notify
	)

virtual

Creates the outcome of a crafting recipe.

Parameters

combatant	The combatant used to craft.
recipeID	The ID/index of the crafting recipe.
notify	A callback function taking a bool parameter (`true` if crafting was successful).

Public Member Functions

Member Function Documentation

◆ Add()

◆ AddMoney()

◆ AddToCraftingList()

◆ ClearCraftingList()

◆ CreateFromCraftingList()

◆ Drop()

◆ Remove()

◆ RemoveFromCraftingList()

◆ RemoveItemType()

◆ SetMoney()

◆ SubMoney()

◆ UseCraftingRecipe()