Class PlayersInventoryItem

Represents a single player's inventory item. This is an inventory item unique to a specific player.

Inheritance

Object

PlayersInventoryItem

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Unity.Services.Economy.Model

Syntax

[Preserve]
public class PlayersInventoryItem

Constructors

PlayersInventoryItem(String, String, IDeserializable, String, EconomyDate, EconomyDate)

Declaration

[Preserve]
public PlayersInventoryItem(string playersInventoryItemId = null, string inventoryItemId = null, IDeserializable instanceData = null, string writeLock = null, EconomyDate created = null, EconomyDate modified = null)

Parameters

Type	Name	Description
String	playersInventoryItemId
String	inventoryItemId
IDeserializable	instanceData
String	writeLock
EconomyDate	created
EconomyDate	modified

Fields

Created

The date this players inventory item was created as an EconomyDate object.

Declaration

[Preserve]
public EconomyDate Created

Field Value

Type	Description
EconomyDate

InstanceData

Any instance data specific to this unique item in the player's inventory.

Declaration

[Preserve]
public IDeserializable InstanceData

Field Value

Type	Description
IDeserializable

InventoryItemId

The configuration ID of the inventory item.

Declaration

[Preserve]
public string InventoryItemId

Field Value

Type	Description
String

Modified

The date this players inventory item was modified as an EconomyDate object.

Declaration

[Preserve]
public EconomyDate Modified

Field Value

Type	Description
EconomyDate

PlayersInventoryItemId

The ID of the unique item specific to this player's inventory.

Declaration

[Preserve]
public string PlayersInventoryItemId

Field Value

Type	Description
String

WriteLock

The current WriteLock string.

Declaration

[Preserve]
public string WriteLock

Field Value

Type	Description
String

Methods

GetItemDefinition()

Gets the configuration definition associated with this player's inventory item.

Declaration

public InventoryItemDefinition GetItemDefinition()

Returns

Type	Description
InventoryItemDefinition	The InventoryItemDefinition associated with this player's inventory item

Exceptions

Type	Condition
EconomyException	Thrown if request is unsuccessful

GetItemDefinitionAsync()

Gets the configuration definition associated with this player's inventory item.

Declaration

[Obsolete("This has been replaced with GetItemDefinition which is not asynchronous and should be accessed from there instead. This API will be removed in an upcoming release.", false)]
public async Task<InventoryItemDefinition> GetItemDefinitionAsync()

Returns

Type	Description
Task<InventoryItemDefinition>	The InventoryItemDefinition associated with this player's inventory item

Exceptions

Type	Condition
EconomyException	Thrown if request is unsuccessful