Interface ITimedReward

A controller that helps keep track of timers that can result in IRewards.

Inherited Members

IReward.rewardData

IReward.CanClaim(Boolean)

IReward.CalculateRewards(Int32)

IPayoutEntity.payoutEntityData

IPayoutEntity.CalculatePayouts()

IEntity.staticDataId

IEntity.instanceId

IEntity.Initialize()

IEntity.Cleanup(IEntityLoaderService)

ITimerListener.timerSubscription

ITimerListener.UpdateProgression(Single)

ITimerListener.OnTimerEnded(Int64)

Namespace: IdleKit.Framework

Assembly: cs.temp.dll.dll

Syntax

public interface ITimedReward : IReward, IPayoutEntity, IEntity, IInjectable, ITimerListener

Properties

durationRemaining

The amount of time remaining in milliseconds before the user can attempt to Claim(). Is not necessarily the only field factored into CanClaim(Boolean).

Declaration

long durationRemaining { get; }

Property Value

Type	Description
Int64

progress

0 to 1 value showing the progress toward the ITimedReward be able to be claimed. This is useful for view purpose.

Declaration

float progress { get; }

Property Value

Type	Description
Single

timedRewardData

The IStaticData associated with this ITimedReward.

Declaration

ITimedRewardData timedRewardData { get; }

Property Value

Type	Description
ITimedRewardData

timedRewardSavedData

The ISavedData associated with this ITimedReward.

Declaration

ITimedRewardSavedData timedRewardSavedData { get; }

Property Value

Type	Description
ITimedRewardSavedData

Methods

Claim()

If CanClaim(Boolean), performs the IStateActions and additional logic necessary to award the user rewardId.

Declaration

void Claim()