My Project
Loading...
Searching...
No Matches
Public Attributes | List of all members
PlayFab.ClientModels.CatalogItem Class Reference

A purchasable item from the item catalog. More...

Inheritance diagram for PlayFab.ClientModels.CatalogItem:
PlayFab.SharedModels.PlayFabBaseModel

Public Attributes

CatalogItemBundleInfo Bundle
 defines the bundle properties for the item - bundles are items which contain other items, including random drop tables and virtual currencies
 
bool CanBecomeCharacter
 if true, then an item instance of this type can be used to grant a character to a user.
 
string CatalogVersion
 catalog version for this item
 
CatalogItemConsumableInfo Consumable
 defines the consumable properties (number of uses, timeout) for the item
 
CatalogItemContainerInfo Container
 defines the container properties for the item - what items it contains, including random drop tables and virtual currencies, and what item (if any) is required to open it via the UnlockContainerItem API
 
string CustomData
 game specific custom data
 
string Description
 text description of item, to show in-game
 
string DisplayName
 text name for the item, to show in-game
 
int InitialLimitedEditionCount
 If the item has IsLImitedEdition set to true, and this is the first time this ItemId has been defined as a limited edition item, this value determines the total number of instances to allocate for the title. Once this limit has been reached, no more instances of this ItemId can be created, and attempts to purchase or grant it will return a Result of false for that ItemId. If the item has already been defined to have a limited edition count, or if this value is less than zero, it will be ignored.
 
bool IsLimitedEdition
 BETA: If true, then only a fixed number can ever be granted.
 
bool IsStackable
 if true, then only one item instance of this type will exist and its remaininguses will be incremented instead. RemainingUses will cap out at Int32.Max (2,147,483,647). All subsequent increases will be discarded
 
bool IsTradable
 if true, then an item instance of this type can be traded between players using the trading APIs
 
string ItemClass
 class to which the item belongs
 
string ItemId
 unique identifier for this item
 
string ItemImageUrl
 URL to the item image. For Facebook purchase to display the image on the item purchase page, this must be set to an HTTP URL.
 
Dictionary< string, uint > RealCurrencyPrices
 override prices for this item for specific currencies
 
List< string > Tags
 list of item tags
 
Dictionary< string, uint > VirtualCurrencyPrices
 price of this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies)
 

Additional Inherited Members

- Public Member Functions inherited from PlayFab.SharedModels.PlayFabBaseModel
string ToJson ()
 

Detailed Description

A purchasable item from the item catalog.


The documentation for this class was generated from the following file: