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.Framework
Assembly: cs.temp.dll.dll
Syntax
public interface IStage : IEntity, IInjectable, IModifiable

Properties

activeGoals

Returns the currently active IGoal controllers associated with this IStage.

Declaration
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[]

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

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.

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

GetActiveGoal(Int32)

Returns the IGoal from activeGoals at index. If the index represents a track that can become empty, returns null if that track is complete or has no goals.

Declaration
IGoal GetActiveGoal(int index)
Parameters
Type Name Description
Int32 index
Returns
Type Description
IGoal

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