Interface IStoreUpgradeableCurrencyCollection

An IStoreEntity that provides a collection of Available and Obtained IUpgradeableCurrencys that the player can purchase using ICurrency in the Store. The IStoreUpgradeableCurrencyCollection is defined per IStage and regularly refreshes after a specified duration.

Inherited Members
Namespace: IdleKit.Gameplay
Assembly: cs.temp.dll.dll
Syntax
public interface IStoreUpgradeableCurrencyCollection : IStoreEntity, IEntity, IInjectable, ITimerListener

Properties

CollectionData

The IData associated with this IStoreUpgradeableCurrencyCollection.

Declaration
IStoreUpgradeableCurrencyCollectionData CollectionData { get; }
Property Value
Type Description
IStoreUpgradeableCurrencyCollectionData

CollectionSavedData

The ISavedData associated with this IStoreUpgradeableCurrencyCollection.

Declaration
IStoreUpgradeableCurrencyCollectionSavedData CollectionSavedData { get; }
Property Value
Type Description
IStoreUpgradeableCurrencyCollectionSavedData

CurrencyPool

The pool of IUpgradeableCurrency currently available for purchase.

Declaration
IUpgradeableCurrency[] CurrencyPool { get; }
Property Value
Type Description
IUpgradeableCurrency[]

TimeRemaining

Returns the time remaining before the CurrencyPool refreshes in milliseconds.

Declaration
long TimeRemaining { get; }
Property Value
Type Description
Int64

Methods

Buy(IUpgradeableCurrency)

Buys an IUpgradeableCurrency from the CurrencyPool.

Declaration
void Buy(IUpgradeableCurrency upgradeableCurrency)
Parameters
Type Name Description
IUpgradeableCurrency upgradeableCurrency

CanBuy(IUpgradeableCurrency)

Returns true if the IUpgradeableCurrency can be purchased by calling Buy(IUpgradeableCurrency).

Declaration
bool CanBuy(IUpgradeableCurrency upgradeableCurrency)
Parameters
Type Name Description
IUpgradeableCurrency upgradeableCurrency
Returns
Type Description
Boolean

GetCost(IUpgradeableCurrency)

Returns the cost to buy an IUpgradeableCurrency.

Declaration
double GetCost(IUpgradeableCurrency upgradeableCurrency)
Parameters
Type Name Description
IUpgradeableCurrency upgradeableCurrency
Returns
Type Description
Double

RefreshPool(IUpgradeableCurrency)

Refreshes the CurrencyPool, where guaranteedUpgradeableCurrency is the IUpgradeableCurrency will definitely be offered in the new pool.

Declaration
void RefreshPool(IUpgradeableCurrency guaranteedUpgradeableCurrency = null)
Parameters
Type Name Description
IUpgradeableCurrency guaranteedUpgradeableCurrency