Class PlayerBalance#

Represents a single currency balance for a player.

Namespace: Unity.Services.Economy.Model#

Syntax#

[Preserve]
public class PlayerBalance

Constructors#

PlayerBalance(String, Int64, String, EconomyDate, EconomyDate)#

Declaration#

[Preserve]
public PlayerBalance(string currencyId = null, long balance = 0L, string writeLock = null, EconomyDate created = null, EconomyDate modified = null)

Parameters#

Fields#

Balance#

The amount of this currency the player has.

Declaration#

[Preserve]
public long Balance

Field Value#

Created#

The date this balance was created as an EconomyDate object.

Declaration#

[Preserve]
public EconomyDate Created

Field Value#

CurrencyId#

The ID of the currency this balance represents.

Declaration#

[Preserve]
public string CurrencyId

Field Value#

Modified#

The date this balance was modified as an EconomyDate object.

Declaration#

[Preserve]
public EconomyDate Modified

Field Value#

WriteLock#

The current WriteLock string.

Declaration#

[Preserve]
public string WriteLock

Field Value#

Methods#

GetCurrencyDefinition()#

Gets the currency definition for this balance.

Declaration#

public CurrencyDefinition GetCurrencyDefinition()

Returns#

GetCurrencyDefinitionAsync()#

Gets the currency definition for this balance.

Declaration#

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

Returns#

Exceptions#