Interface IGoal
An IGoal is an IActivatable that is contained in an ITrack or one or more sequences in an IStage. The player can make progress towards an IGoals progression target. Once an IGoal progression target has been hit the IGoal can be claimed and the player can be rewarded.
Inherited Members
Namespace: IdleKit.Framework
Assembly: cs.temp.dll.dll
Syntax
public interface IGoal : IActivatable, IEntity, IInjectable
Properties
canClaim
Returns true if the IGoal can be claimed.
Declaration
bool canClaim { get; }
Property Value
Type | Description |
---|---|
Boolean |
currentProgression
Returns the progress of the IGoal
Declaration
double currentProgression { get; }
Property Value
Type | Description |
---|---|
Double |
goalData
Declaration
IGoalData goalData { get; }
Property Value
Type | Description |
---|---|
IGoalData |
goalSavedData
Returns the saved data associated with this IGoal.
Declaration
IGoalSavedData goalSavedData { get; }
Property Value
Type | Description |
---|---|
IGoalSavedData |
normalizedProgress
Returns the current progression as a normalized value (0 - 1).
Declaration
double normalizedProgress { get; }
Property Value
Type | Description |
---|---|
Double |
targetProgression
Returns the target progression amount for this IGoal.
Declaration
double targetProgression { get; }
Property Value
Type | Description |
---|---|
Double |