Beamable SDK
Public Member Functions | Public Attributes | Protected Member Functions | Properties | Events | List of all members
Beamable.Player.PlayerCurrency Class Reference

The PlayerCurrency represents one currency of a player. The Amount shows the current value of the currency. More...

Inheritance diagram for Beamable.Player.PlayerCurrency:
Inheritance graph
[legend]
Collaboration diagram for Beamable.Player.PlayerCurrency:
Collaboration graph
[legend]

Public Member Functions

override bool Equals (object obj)
 
override int GetHashCode ()
 
- Public Member Functions inherited from Beamable.Common.Player.DefaultObservable
virtual int GetBroadcastChecksum ()
 The broadcast checksum is a concept for change-detection. More...
 

Public Attributes

string CurrencyId
 The id of the CurrencyContent that this currency is for.
 

Protected Member Functions

bool Equals (PlayerCurrency other)
 
- Protected Member Functions inherited from Beamable.Common.Player.DefaultObservable
void TriggerUpdate ()
 

Properties

long Amount [getset]
 The current amount of the currency. This value can change over time, and will get realtime updates from the server. Use the OnAmountUpdated event to be notified when that happens. More...
 

Events

Action< long > OnAmountUpdated
 An event that happens whenever the Amount changes this event happens after DefaultObservable.OnUpdated
 
- Events inherited from Beamable.Common.Player.DefaultObservable
Action OnUpdated
 A "change" only happens when the value of the GetBroadcastChecksum changes.
 
- Events inherited from Beamable.Common.Player.IObservable
Action OnUpdated
 An event that happens whenever the object has changed.
 

Detailed Description

The PlayerCurrency represents one currency of a player. The Amount shows the current value of the currency.

Property Documentation

◆ Amount

long Beamable.Player.PlayerCurrency.Amount
getset

The current amount of the currency. This value can change over time, and will get realtime updates from the server. Use the OnAmountUpdated event to be notified when that happens.

You can set this currency locally, but isn't recommended.


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