Interface IPayoutProjection
This utility class represents the global payout rates per-millisecond for each ICurrency in the game up until the TimeExpired timestamp. TimeExpired represents the timestamp at which a payout rate changes, such as a ITimedBoost expiring.
Namespace: IdleKit.Gameplay
Assembly: cs.temp.dll.dll
Syntax
public interface IPayoutProjectionRemarks
The calculated list of IPayoutProjection by the IProjectionService can be sent to the server to estimate user's score for leader-board implementations. Within IdleKit it is used by the IProjectionService.
Properties
PayoutRates
The array holds the CurrencyAmount with the Id for the ICurrency and the Amount for the global payout rate for that ICurrency per millisecond.
Declaration
CurrencyAmount[] PayoutRates { get; }Property Value
| Type | Description |
|---|---|
| CurrencyAmount[] |
TimeExpired
The expiry time in milliseconds for this IPayoutProjection. This is usually correlates to the expiry time of a ITimedBoost.
Declaration
long TimeExpired { get; }Property Value
| Type | Description |
|---|---|
| Int64 |
Methods
GetPayoutRate(String)
Returns the payout rate for the ICurrency associated with currencyId.
Declaration
double GetPayoutRate(string currencyId)Parameters
| Type | Name | Description |
|---|---|---|
| String | currencyId |
Returns
| Type | Description |
|---|---|
| Double |
HasPayoutRate(String)
Does this IPayoutProjection contains the payout rate for the currencyId.
Declaration
bool HasPayoutRate(string currencyId)Parameters
| Type | Name | Description |
|---|---|---|
| String | currencyId |
Returns
| Type | Description |
|---|---|
| Boolean |