Interface ICurrency
Inherited Members
Namespace: IdleKit.Gameplay
Assembly: cs.temp.dll.dll
Syntax
public interface ICurrency : IExchangeable, IUnlockable, ITaggedEntity, IPayoutEntity, IEntity, IInjectableProperties
CurrencyData
This ICurrency's static data
Declaration
ICurrencyData CurrencyData { get; }Property Value
| Type | Description |
|---|---|
| ICurrencyData |
CurrencySavedData
This ICurrency's saved data
Declaration
ICurrencySavedData CurrencySavedData { get; }Property Value
| Type | Description |
|---|---|
| ICurrencySavedData |
RarityData
A specific type of ITagData used to define how rare an ICurrency is within the game. DefaultExchangeValue could also be used to determine GetExchangeValue().
Declaration
IRarityData RarityData { get; }Property Value
| Type | Description |
|---|---|
| IRarityData |
Methods
Add(Double)
Adds an amount to this ICurrency's saved amount Generally only to be called from IStateActions
Declaration
void Add(double amount)Parameters
| Type | Name | Description |
|---|---|---|
| Double | amount |
Get()
Returns this ICurrency's current saved value
Declaration
double Get()Returns
| Type | Description |
|---|---|
| Double |
GetRampingIncrement()
Returns the ramping increment for purchasing this ICurrency from the store, i.e. how much more each additional purchase of this ICurrency entity costs.
Declaration
double GetRampingIncrement()Returns
| Type | Description |
|---|---|
| Double |
Remove(Double)
Removes an amount from this ICurrency's saved amount Generally only to be called from IStateActions
Declaration
void Remove(double amount)Parameters
| Type | Name | Description |
|---|---|---|
| Double | amount |
Set(Double)
Sets this ICurrency's saved amount to the provided value Generally only to be called from IStateActions
Declaration
void Set(double amount)Parameters
| Type | Name | Description |
|---|---|---|
| Double | amount |