Interface IStandardContentFeatures

A component interface utilize by the IStandardContent that provides additional functionality such as ITrade, ITimedReward, and IBoost functionality that are common in idle games.

Namespace: IdleKit.Framework

Assembly: cs.temp.dll.dll

Syntax

public interface IStandardContentFeatures : IInjectable

Properties

activeTrade

Returns the ITrade that is currently offered to the player.

Declaration

ITrade activeTrade { get; }

Property Value

Type	Description
ITrade

collectorEntities

Returns all ICollectorEntity controllers associated with this IStandardContentFeatures.

Declaration

ICollectorEntity[] collectorEntities { get; }

Property Value

Type	Description
ICollectorEntity[]

softCurrencyMissingResourcesMultiplier

Returns the missing resources IExchangeRateMultiplier used for soft currency.

Declaration

IExchangeRateMultiplier softCurrencyMissingResourcesMultiplier { get; }

Property Value

Type	Description
IExchangeRateMultiplier

timedReward

Returns the ITimedReward associated with this IStandardContentFeatures.

Declaration

ITimedReward timedReward { get; }

Property Value

Type	Description
ITimedReward

trades

Returns the ITrades used within the IStandardContent.

Declaration

ITrade[] trades { get; }

Property Value

Type	Description
ITrade[]

tradeTimerProgression

If there is currently no activeTrade, returns the progression until a new ITrade is activated, represented as a float between 0 and 1. When the progression reaches 1, RefreshTrade() is called.

Declaration

float tradeTimerProgression { get; }

Property Value

Type	Description
Single

upgradeableCurrencyMissingResourcesMultiplier

Returns the missing resources IExchangeRateMultiplier used for upgradeable currency.

Declaration

IExchangeRateMultiplier upgradeableCurrencyMissingResourcesMultiplier { get; }

Property Value

Type	Description
IExchangeRateMultiplier

videoAdBoost

Returns the ITimedBoost associated with this IStandardContentFeatures.

Declaration

ITimedBoost videoAdBoost { get; }

Property Value

Type	Description
ITimedBoost

Methods

Cleanup(IEntityLoaderService)

Responsible for performing cleanup on the child IEntitys and other objects owned by this IStandardContentFeatures. It is important to perform Cleanup(IEntityLoaderService) to make sure there is no memory leak.

Declaration

void Cleanup(IEntityLoaderService entityLoaderService)

Parameters

Type	Name	Description
IEntityLoaderService	entityLoaderService

Initialize()

Responsible for performing the setup logic including subscription to the IActions for this IStandardContentFeatures.

Declaration

void Initialize()

RefreshTrade()

Try to find a new activeTrade, a new valid activeTrade will be selected. If there is no valid ITrade to be activate, the tradeTimerProgression would be restarted.

Declaration

void RefreshTrade()