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

Parameters

Type	Name	Description
String	currencyId
Int64	balance
String	writeLock
EconomyDate	created
EconomyDate	modified

Fields

Balance

The amount of this currency the player has.

Declaration

[Preserve]
public long Balance

Field Value

Type	Description
Int64

Created

The date this balance was created as an EconomyDate object.

Declaration

[Preserve]
public EconomyDate Created

Field Value

Type	Description
EconomyDate

CurrencyId

The ID of the currency this balance represents.

Declaration

[Preserve]
public string CurrencyId

Field Value

Type	Description
String

Modified

The date this balance was modified as an EconomyDate object.

Declaration

[Preserve]
public EconomyDate Modified

Field Value

Type	Description
EconomyDate

WriteLock

The current WriteLock string.

Declaration

[Preserve]
public string WriteLock

Field Value

Type	Description
String

Methods

GetCurrencyDefinition()

Gets the currency definition for this balance.

Declaration

public CurrencyDefinition GetCurrencyDefinition()

Returns

Type	Description
CurrencyDefinition	The CurrencyDefinition that this balance refers to.

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

Type	Description
Task<CurrencyDefinition>	The CurrencyDefinition that this balance refers to.

Exceptions

Type	Condition
EconomyException	Thrown if request is unsuccessful