Item Definition
Defines a Steam Inventory Item

Definition

1
public class ItemDefinition : ScriptableObject
Copied!
Represents a Steam Inventory Item of any type. This object contains all the schema data for any possible item. The specifics of each field are defined in Steam's Inventory Schema documentaiton.
Steam Inventory Schema (Steamworks Documentation)
When importing items from Steam API note that Valve omits the bundle node from Items of type 'Generator' thus anytime you import items from Valve the "Items" field on generator type items will be empty and must be set manually before you can export them again.
This is a deliberate decision from Valve and has been confirmed it is not a bug it is by design. If you (like us) would like it changed then please submit a support ticket to Valve letting them know that this decision adversly impacts you.

Fields and Attributes

Id

1
public SteamItemDef_t Id => get;
Copied!
Returns the item defintion ID.

Details

1
public List<ItemDetail> Details => get;
Copied!
Returns a list of all the known item details the local user owns of this item type.

TotalQuantity

1
public long TotalQuantity => get;
Copied!
Returns the quantity of this item the user owns, this is the sum of all quanity in each detail.

DisplayName

1
public string DisplayName => get;
Copied!
This can only be used if you have called LoadItemDefintions from the Inventory API. It returns the localized name of the item if any.

HasPrice

1
public bool HasPrice => get;
Copied!
Indicates rather or not this item has a price ... this will always return false until after the system has fully initalized. Initalization occures on initalization of the API and can take a few seconds.

CurrencyCode

1
public Currency.Code CurrencyCode => get;
Copied!
Returns the currency code used by the local user's currency in Steam. e.g. USD, GBP, EUR, etc.

CurrencySymbol

1
public string CurrencySymbol => get;
Copied!
Returns the sting symbol used by the local user's currency.

CurrentPrice

1
public ulong CurrentPrice => get;
Copied!
The price of the item as a whole number e.g. 1 represents the smallest denominator in the user's currency so 100 would represent 100 cents or 1 dolar in USD ... this will always return false until after the system has fully initalized. Initalization occures on initalization of the API and can take a few seconds.
No price found if this returns 0.

BasePrice

1
public ulong BasePrice => get;
Copied!
The base price of the item as a whole number e.g. 1 represents the smallest denominator in the user's currency so 100 would represent 100 cents or 1 dolar in USD ... this will always return false until after the system has fully initalized. Initalization occures on initalization of the API and can take a few seconds.
No price found if this returns 0.

Type

1
public InventoryItemType Type => get;
Copied!
This indicates the type of item this definition represents.

Name

1
public string Name => get;
Copied!
Gets the simple name of the item as defined in your schema. If you need the language based name see DisplayName.

Description

1
public string Description => get;
Copied!
Gets the simple description as defined in your schema. If you need the langauge based name you will need to fetch item defintions and get the description property.

DisplayType

1
public string DisplayType => get;
Copied!
Gets the simple display type as defined in your schema. If you need the langauge based name you will need to fetch item defintions and get the description property.

Bundle

1
public Bundle.Entry[] Bundle => get;
Copied!
Gets the array of Bundle.Entry objects defining the contents of this bundle if any

PromoRuleOwns

1
public AppId_t[] PromoRuleOwns => get;
Copied!
Returns the list of app ids that the user must own for this item to be droped as a promo item.

PromoRuleAchievements

1
public string[] PromoRuleAchievemets => get;
Copied!
Returns the list of achievment IDs that the user must have achieved for this item to be droped as a promo item.

PromoRulePlayed

1
public PromoRule.PlayedEntry[] PromoRulePlayed => get;
Copied!
Returns the list of player entries ... indicates the app ID and length of time in min that the player must have played before this item can be droped as a promo.

DropStartTime

1
public string DropStartTime => get;
Copied!
The item drop start time if this is a promo item.

Recipies

1
public ExchangeRecipe[] Recipies => get;
Copied!
Returns the array of exchange recipies for this item if any

BackgroundColor

1
public Color BackgroundColor => get;
Copied!
The background color used in the Steam Store and marketplace entries if any

NameColor

1
public Color NameColor => get;
Copied!
The name color used in the Steam Store and marketplace entries if any

IconUrl

1
public string IconUrl => get;
Copied!
The icon URL for this item if any, this is used by the Steam Store and marketplace entries.

IconUrlLarge

1
public string IconUrlLarge => get;
Copied!
The icon URL for this item if any, this is used by the Steam Store and marketplace entries.

Marketable

1
public bool Marketable => get;
Copied!
Can this item be sold by players on the Steam marketplace.

Tradable

1
public bool Tradable => get;
Copied!
Can this item be traded between players via the Steam Inventory system.

Tags

1
public ItemTag[] Tags;=> get
Copied!
The set of tags related to this item.

TagGenerators

1
public ItemDefinition[] TagGenerators => get;
Copied!
The array of items used as tag generators related to this item

TagGeneratorValueArray

1
public TagGeneratorValue[] TagGeneratorvalueArray => get;
Copied!
The array of values that can be generated for this item

StoreTags

1
public string[] StoreTags => get;
Copied!
Returns the array of store tags assigned to this item

StoreImages

1
public string[] StoreImages => get;
Copied!
Returns the array of store images assigned to this item

Hidden

1
public bool Hidden => get;
Copied!
Is this item hidden from the user's inventory

StoreHidden

1
public bool StoreHidden => get;
Copied!
Is this item hidden from the store

Methods

Add Promo Item

1
public bool AddPromoItem(callback);
Copied!
Grants the item in a one-time promotional to the local user

Get Consume Orders

1
public ConsumeOrder[] GetConsumeOrders(quantity);
Copied!
Creates ConsumeOrders which can be used with the Consume method to consume instances of this item if available. This is only needed when consuming more than 1 instance at a time.

Consume

1
public bool Consume(callback);
Copied!
1
public bool Consume(order, callback);
Copied!
Consume 1 or many instances of this item if the player owns them

Can Exchange

This method checks if a user can exchange for this item using a specific recipie. You can get the list of available recipies from the ItemDefinition.item_exchange or you can create the recipie manually if you know the items needed.
This will always return false if the recipie uses tags in any of the required items
1
public bool CanExchange(ExchangeRecipe, out List<ExchangeEntry>);
Copied!

Get Exchange Entry

1
public bool GetExchangeEntry(quantity, out entries);
Copied!
Gets a set of ExchangeEntry objects that match the quantity provided if the player's owns them. This can be used with Exchange to "craft" 1 item by exchanging a set of other items.

Exchange

Exchanges a collection of ExchangeEntry for this item. The Valve backend will validate and insure that this set of ExchangeEntries satisifies one of the configured excahnge recipies for this item.
1
public void Exchange(IEnumerable<ExchangeEntry>, callback);
Copied!
Exchanges a set of ExchangeEntry objects to create a new instance of this item.

Generate Item

Can only be used by developers for development testing
1
public void GenerateItem(callback);
Copied!
Only available to developers, this simply creates a new instance of this item

Start Purchase

1
public void StartPurchase(callback);
Copied!
If the item is confugred correctly for store purchases this will open the store loading the cart with the indicated number of items to be purcahsed.

CurrentPriceString

1
public string CurrentPriceString();
Copied!
This reurnts the culture formated string for the currency assuming it is base 100. This works well for curencies such as USD, EUR, GBP or anything with a "cent" concept but will not work well for currencies that always use whole numbers such as the Yen.

BasePriceString

1
public string BasePriceString();
Copied!
This reurnts the culture formated string for the currency assuming it is base 100. This works well for curencies such as USD, EUR, GBP or anything with a "cent" concept but will not work well for currencies that always use whole numbers such as the Yen.

Trigger Drop

1
public void TriggerDrop(callback);
Copied!
Triggers a play time drop assuming the player has played long enough and the item is a playtime generator item.

How To

Check Ownership

First you need to make sure you have loaded the user's inventory. This is probably already done for you in that the Heathen Steamworks Behaviour will call GetAllItems when it first initalizes however its important to understand that Steam Inventory can change from many different points of view both in and out of game so to be sure you have the latest we do sugest you refresh your local view of the user's inventory jsut before you preform any sinsative tasks.
Once your happy that the local state is fresh enough for your purposes you can check for ownership of an item by simply checking its TotalQuantity
1
if(item.TotalQuantity > 0)
2
Debug.Log("The user owns " + item.TotalQuanity + " of this item.");
3
else
4
Debug.Log("The user does not own any of this item.");
Copied!

Refresh Inventory

You can refresh the local state of items at any time, keep in mind Valve may rate limit this and simply return the most recent cashe value.
To refresh the full inventory
1
API.Inventory.Client.GetAllItems(callback);
Copied!
The callback is optional and can be used to know when the results comeback. The Heathen SteamSettings object will update the state of all known ItemDefinition objects so its not nessisary to process the resulting InventoryResults object unless you want to check for something specific.
You can also choose to refresh a specific set of item instances
1
API.Inventory.Client.GetItemsByID(instances, callback);
Copied!
As with GetAllItems the callback is optional and can be used to check the specifics of the resullting data or simply to know when the request has been completed.

Add Promo Item

Short cut to the Add Promo Item of the API.Inventory interface.
1
item.AddPromoItem(callback);
Copied!

Consume

You can use the Item Definition to consume 1 or more instances of the item with simple method calls.

Consume a single instance

This is the simplest and most common approch, it assumes you are consuming a single instance of the item.
1
item.Consume(callback);
Copied!

Consume multiple

When consuming multiple instnaces we need to first get a set of orders.
Steam Inventory Items may have zero (0) or many item details which will consist of zero (0) or many instances each. its simplest to think of an Item Detail as a stack of that type of item. Each stack may have 0 or many items of that type in it. When consuming we need to indicate the stack to consume from and how many to consume from that stack. That is what the GetConsumeOrders method does, it provides a refernce to which stacks should consume how many to result in the total you indicated.
Example:
  • instance A = 4 quantity
  • instance B = 0 quantity
  • instance C = 2 quantity
  • instance D = 3 quantity
In this case the user has a total of 9 of this item spread across 4 insances. If you requested to consume 5 of this item you would get 2 orders back.
  1. 1.
    Order 1 would contain 4 from instance A
  2. 2.
    Order 2 would contain 1 from instance C
Once you had the orders its up to you to call the Consume method on the order.
1
var orders = item.GetConsumeOrders(quantity);
2
foreach(var order in orders)
3
{
4
item.Consume(order, callback);
5
}
Copied!

Exchange

To exchange some items for another item, the item you wish to exchange for must define the recipie of items in its Item Definition as upoloaded to Steam's portal.
The item recipie is how this is able to run client side, since the item definition defines what exchanges are valid, and the Steam backend controls what items the player owns then Steam can assuradly confirm that a recipie is valid.
An exchange, exchanges some set of items for some other item. Its most simple to think of this as crafting, you provide some set of ingrediants and the result is some single item. When you call Exchange on an item you provide a set of items and if the process is succesfult you will recieve evidence of a new instnace of this item in the player's inventory.
To start the proces you must first identify the specifc item instnaces to be consumed. How you generate ExchangeEntry objects for an item depends on the specific needs of the recipie. In most cases a recipie will require a number of a specific item type, in this case you can simply call GetExchangeEntry on the specific item.
1
if(itemToExchange.GetExchangeEntry(quantity, out entries))
2
{
3
// Enough where found
4
}
5
else
6
{
7
// Not enough of this item available
8
}
Copied!
Once you have the collection of ExchangeEntries you can pass them into the item you wish to exchange them for.
1
item.Exchange(exchangeEntries, callback);
Copied!

Use Cases

Exchange chest for bundle
1
if(chest.GetExchangeEntry(1, out EchangeEntry[] entries))
2
{
3
bundle.Exchange(entries, (result, error) => {
4
Debug.Log("result contains the items we gave the player");
5
});
6
}
7
else
8
{
9
Debug.Log("The player didn't have any chests");
10
}
Copied!
Exchange for a particular recipie;
In this use case we pick a particular recipie for the item we want to exchange ... lets say we want to exchange 10 gold and 1 gem for a random item. Lets assue our random item is defined as an item generator named randomLoot;
Lets allso assume that the recipie to do this is the first recipie in our randomLoot item.
1
var recipie = randomLoot.item_exchange.recipie[0];
2
3
if(randomLoot.CanExchange(recipie, out List<ExchangeEntry> entries))
4
{
5
//This returns true if the local user owns the required items
6
//We can use the output entries to execute the exchange
7
randomLoot.Exchange(entries, (responce) =>
8
{
9
if(responce.result == EResult.k_EResultOK)
10
Debug.Log("Complete");
11
else
12
Debug.LogWarning("Something went wrong ... check the result");
13
});
14
}
Copied!
Exchange 10 iron and 50 gold for 1 ironSword;
In this example we will manually build out the exchange entries checking each one as we go.
1
if(iron.GetExchangeEntry(10, out EchangeEntry[] ironEntries))
2
{
3
if(gold.GetExcahngeEntry(50, out ExchangeEntry[] goldEntries))
4
{
5
var recipie = new List<ExchangeEntry>();
6
recipie.Add(ironEntries);
7
recipie.Add(goldEntries);
8
ironSword.Exchange(recipie, (result, error) => {
9
Debug.Log("results contains the sword if any");
10
});
11
}
12
else
13
{
14
Debug.Log("Not enough gold");
15
}
16
}
17
else
18
{
19
Debug.Log("Not enough iron");
20
}
Copied!

Generate or Grant Items

From the Client API this is only avialable to developers of this app for development testing. If you need to do this in production for a non-developer then you need to use the Web API.
Grants the player this item, this is used only by developers and is meant for testing only.
1
item.GenerateItem(callback);
Copied!
To generate multiple instances of this item you can use
1
item.GenerateItem(count, callback);
Copied!

Start Purchase

Only items that have a valid price or price category and are not set to store hidden or hidden in general can be called to start purchase.
You can use API.Inventory.Client.StartPurchase to start a purchase on a complex cart of items. This example on the Item Defintion is for starting a purchase of a single item or some quantity of a signle item.
1
item.StartPurchase(callback);
Copied!
or
1
item.StartPurchse(count, callback);
Copied!
or
1
API.Inventory.Client.StartPurchase(items, itemQuantities, callback);
Copied!