Item Type

Scripting with the ItemType class.

An ItemType is a type of an item. Item types are used to set commonalities of a group of items and are also useful for filtering items in the inventory.

Fields & Properties

Name	Description	Type	Access
id	The unique ID of this item type.	int	public
displayName	The display name of this type that will be displayed in-game.	string	public
localizedDisplayNameKey	The key of the localized display name string.	string	public
icon	The item type icon that will be displayed in the inventory filter list.	Sprite	public
iconColorTint	The color tint of the icon.	Color	public
parent	The parent item type. This will be null if the item type is not a subtype.	ItemType	public
enchantmentMode	The enchantment mode of this item type.	EnchantmentMode	public
sortingOrder	The order in which the item type option will appear in the inventory. Lower values will appear first.	int	public
equippable	If this item type should support equipping.	bool	public
consumable	If this item type should support consuming.	bool	public
stackable	If stacking is possible for items of this type.	bool	public
droppable	If the player can manually drop items of this type.	bool	public
sellable	If items of this type can be sold in market places.	bool	public
IsSubtype	If this is a subtype of another.	bool	public
IsEnchantable	If items of this are enchantable.	bool	public
IsEnchanter	If items of this type are enchanter.	bool	public

Enchantment Mode

EnchantmentMode is an enum that sets the enchantment rule for the items of the item type.

Name	Description
None	Items of this type cannot be enchanted or be used for enchanting.
Enchantable	Items of this type can be enchanted.
Enchanter	Items of this type can be used for enchanting.
Both	Items of this type can be enchanted and used for enchanting.

Creating Item Types

It's not at all recommended to create item types at runtime, but it is possible. Item types are scriptable objects which cannot be created as assets at runtime for later use. You would need to load your generated item types on your own.

ItemType myItemType = ScriptableObject.CreateInstance<ItemType>();

Item type IDs must be unique. When creating item types from the Item Type Manager, unique IDs are set automatically. However, this is not done when creating item types at runtime. You'd need to create your own method of ensuring IDs of generated item types are unique.

Getting Item Types

Single Item Type

You can get item types by their name or ID with the GetItemType method.

ItemType myItemType = Inventool.GetItemType("My Item Type Name");

Get All Item Types

var itemTypes = Inventool.GetAllItemTypes();

Get All Parent Item Types

var itemTypes = Inventool.GetAllParentItemTypes();

Get All Sub Item Types

var itemTypes = Inventool.GetAllSubItemTypes();