Interface IMilestone

IMilestones are IActivatables used to track progression through a IEventContent. Once a IMilestone has been completed, its associated rewards can be claimed.

Inherited Members

IActivatable.activatableData

IActivatable.Activate()

IActivatable.Deactivate()

IActivatable.Reset()

IActivatable.isActive

IEntity.staticDataId

IEntity.instanceId

IEntity.Initialize()

IEntity.Cleanup(IEntityLoaderService)

Namespace: IdleKit.Framework

Assembly: cs.temp.dll.dll

Syntax

public interface IMilestone : IActivatable, IEntity, IInjectable

Properties

canClaim

Returns true if the IMilestone can be claimed

Declaration

bool canClaim { get; }

Property Value

Type	Description
Boolean

currentProgression

Returns the current progression amount for this IMilestone

Declaration

double currentProgression { get; }

Property Value

Type	Description
Double

milestoneData

Returns the IMilestoneData associated with this IMilestone.

Declaration

IMilestoneData milestoneData { get; }

Property Value

Type	Description
IMilestoneData

milestoneSavedData

Returns the IMilestoneSavedData associated with this IMilestone.

Declaration

IMilestoneSavedData milestoneSavedData { get; }

Property Value

Type	Description
IMilestoneSavedData

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 IMilestone

Declaration

double targetProgression { get; }

Property Value

Type	Description
Double

Methods

Activate(Double)

Activates the IMilestone and sets the progression to initialProgress

Declaration

void Activate(double initialProgress)

Parameters

Type	Name	Description
Double	initialProgress

Remarks

This can be called multiple times. Use this instead of Activate() when activating a milestone with initial overflow progress.