Interface IStage

A IStage contains collections of IGeneratorEntitys and IGoals. A player progresses through a IStage by using the IGeneratorEntitys to generate ICurrency and completing IGoals. Once enough Goals have been completed the player can ascend to the next IStage.

Inherited Members
Namespace: IdleKit.Gameplay
Assembly: cs.temp.dll.dll
Syntax
public interface IStage : IEntity, IInjectable, IModifiable

Properties

ActiveGoals

Declaration
[Obsolete("Deprecated in version L.1, use GetActiveGoals() instead.", true)]
IGoal[] ActiveGoals { get; }
Property Value
Type Description
IGoal[]

GeneratorEntities

Returns the IGeneratorEntity controllers associated with this IStage.

Declaration
IGeneratorEntity[] GeneratorEntities { get; }
Property Value
Type Description
IGeneratorEntity[]

GoalTracks

Returns the IGoalTrack controllers associated with this IStage.

Declaration
IGoalTrack[] GoalTracks { get; }
Property Value
Type Description
IGoalTrack[]

StageData

Returns the IStageData associated with this IStage.

Declaration
IStageData StageData { get; }
Property Value
Type Description
IStageData

StageSavedData

Returns the IStageSavedData associated with this IStage.

Declaration
IStageSavedData StageSavedData { get; }
Property Value
Type Description
IStageSavedData

StoreUpgradeableCurrencyCollections

Returns the IStoreUpgradeableCurrencyCollections associated with this IStage.

Declaration
IStoreUpgradeableCurrencyCollection[] StoreUpgradeableCurrencyCollections { get; }
Property Value
Type Description
IStoreUpgradeableCurrencyCollection[]

Methods

CanAscend()

Returns true if the player can ascend to the next IStage.

Declaration
bool CanAscend()
Returns
Type Description
Boolean

ClaimGoal(IGoal)

Claims the active IGoal from the IStage, does nothing if IGoal is not claimable.

Declaration
void ClaimGoal(IGoal goal)
Parameters
Type Name Description
IGoal goal

GetActiveGoal(Int32)

Declaration
[Obsolete("Deprecated in version L.1, use GetActiveGoals() instead.", true)]
IGoal GetActiveGoal(int index)
Parameters
Type Name Description
Int32 index
Returns
Type Description
IGoal

GetActiveGoals()

Returns the currently active IGoal controllers associated with this IStage.

Declaration
IGoal[] GetActiveGoals()
Returns
Type Description
IGoal[]

GetAscensionPower(Boolean, Double, IModifier[])

Returns the ascension power a player has for this IStage. If applyModifiers is true, all IModifier that affect the value will be applied. Ascension power can only be affected by IModifier.

Declaration
double GetAscensionPower(bool applyModifiers = true, double ascensionPower = 1, IModifier[] excludedModifiers = null)
Parameters
Type Name Description
Boolean applyModifiers
Double ascensionPower
IModifier[] excludedModifiers
Returns
Type Description
Double
Examples
IUpgradeableCurrency

GetGenerator(String)

Returns the IGeneratorEntity with the provided id that is associated to the IStage.

Declaration
IGeneratorEntity GetGenerator(string id)
Parameters
Type Name Description
String id
Returns
Type Description
IGeneratorEntity

GetGoal(String)

Returns the IGoal with the provided id so long as it is in this IStage else, returns null.

Declaration
IGoal GetGoal(string id)
Parameters
Type Name Description
String id
Returns
Type Description
IGoal

GetNumberOfCompletedGoals()

Returns the number of completed goals in this IStage.

Declaration
int GetNumberOfCompletedGoals()
Returns
Type Description
Int32