C# Class PlayFab.ClientModels.CatalogItem

A purchasable item from the item catalog
Inheritance: PlayFabModelBase
Mostra file Open project: PlayFab/PlayFabGameServer Class Usage Examples

Public Properties

Property Type Description
Bundle CatalogItemBundleInfo
CanBecomeCharacter bool
CatalogVersion string
Consumable CatalogItemConsumableInfo
Container CatalogItemContainerInfo
CustomData string
Description string
DisplayName string
InitialLimitedEditionCount int
IsLimitedEdition bool
IsStackable bool
IsTradable bool
ItemClass string
ItemId string
ItemImageUrl string
RealCurrencyPrices uint>.Dictionary
Tags List
VirtualCurrencyPrices uint>.Dictionary

Property Details

Bundle public_oe property

defines the bundle properties for the item - bundles are items which contain other items, including random drop tables and virtual currencies
public CatalogItemBundleInfo,PlayFab.ClientModels Bundle
return CatalogItemBundleInfo

CanBecomeCharacter public_oe property

if true, then an item instance of this type can be used to grant a character to a user.
public bool CanBecomeCharacter
return bool

CatalogVersion public_oe property

catalog version for this item
public string CatalogVersion
return string

Consumable public_oe property

defines the consumable properties (number of uses, timeout) for the item
public CatalogItemConsumableInfo,PlayFab.ClientModels Consumable
return CatalogItemConsumableInfo

Container public_oe property

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
public CatalogItemContainerInfo,PlayFab.ClientModels Container
return CatalogItemContainerInfo

CustomData public_oe property

game specific custom data
public string CustomData
return string

Description public_oe property

text description of item, to show in-game
public string Description
return string

DisplayName public_oe property

text name for the item, to show in-game
public string DisplayName
return string

InitialLimitedEditionCount public_oe property

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.
public int InitialLimitedEditionCount
return int

IsLimitedEdition public_oe property

BETA: If true, then only a fixed number can ever be granted.
public bool IsLimitedEdition
return bool

IsStackable public_oe property

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
public bool IsStackable
return bool

IsTradable public_oe property

if true, then an item instance of this type can be traded between players using the trading APIs
public bool IsTradable
return bool

ItemClass public_oe property

class to which the item belongs
public string ItemClass
return string

ItemId public_oe property

unique identifier for this item
public string ItemId
return string

ItemImageUrl public_oe property

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.
public string ItemImageUrl
return string

RealCurrencyPrices public_oe property

override prices for this item for specific currencies
public Dictionary RealCurrencyPrices
return uint>.Dictionary

Tags public_oe property

list of item tags
public List Tags
return List

VirtualCurrencyPrices public_oe property

price of this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies)
public Dictionary VirtualCurrencyPrices
return uint>.Dictionary