Show / Hide Table of Contents

    Class StoreTimedReward

    Inheritance
    Object
    StoreTimedReward
    Implements
    IStoreTimedReward
    IReward
    IPayoutEntity
    IStoreEntity
    ITimedActivatable
    IActivatable
    IEntity
    IInjectable
    ITimerListener
    Inherited Members
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Object.ToString()
    Object.ReferenceEquals(Object, Object)
    Namespace: IdleKit.Gameplay
    Assembly: cs.temp.dll.dll
    Syntax
    public class StoreTimedReward : IStoreTimedReward, IReward, IPayoutEntity, IStoreEntity, ITimedActivatable, IActivatable, IEntity, IInjectable, ITimerListener

    Constructors

    StoreTimedReward(String)

    Declaration
    public StoreTimedReward(string id)
    Parameters
    Type Name Description
    String id

    Fields

    _actionService

    Declaration
    protected IActionService _actionService
    Field Value
    Type Description
    IActionService

    _dataService

    Declaration
    protected IDataService _dataService
    Field Value
    Type Description
    IDataService

    _id

    Declaration
    protected readonly string _id
    Field Value
    Type Description
    String

    _rewardService

    Declaration
    protected IRewardService _rewardService
    Field Value
    Type Description
    IRewardService

    _storeTimedRewardData

    Declaration
    protected IStoreTimedRewardData _storeTimedRewardData
    Field Value
    Type Description
    IStoreTimedRewardData

    _storeTimedRewardSavedData

    Declaration
    protected IStoreTimedRewardSavedData _storeTimedRewardSavedData
    Field Value
    Type Description
    IStoreTimedRewardSavedData

    _timerService

    Declaration
    protected ITimerService _timerService
    Field Value
    Type Description
    ITimerService

    _timerSubscription

    Declaration
    protected ITimerSubscription _timerSubscription
    Field Value
    Type Description
    ITimerSubscription

    Properties

    Activatable

    Declaration
    public IActivatable Activatable { get; }
    Property Value
    Type Description
    IActivatable

    ActivatableData

    Declaration
    public IActivatableData ActivatableData { get; }
    Property Value
    Type Description
    IActivatableData

    Id

    Declaration
    public virtual string Id { get; }
    Property Value
    Type Description
    String

    IsActive

    Declaration
    public bool IsActive { get; }
    Property Value
    Type Description
    Boolean

    IsUnlocked

    Declaration
    public virtual bool IsUnlocked { get; }
    Property Value
    Type Description
    Boolean

    PayoutEntityData

    Declaration
    public virtual IPayoutEntityData PayoutEntityData { get; }
    Property Value
    Type Description
    IPayoutEntityData

    Progress

    0 to 1 value showing the progress toward the IStoreTimedReward to be claimable. This is useful for view purposes.

    Declaration
    public virtual float Progress { get; }
    Property Value
    Type Description
    Single

    RewardData

    Declaration
    public virtual IRewardData RewardData { get; }
    Property Value
    Type Description
    IRewardData

    StoreEntityData

    Declaration
    public virtual IStoreEntityData StoreEntityData { get; }
    Property Value
    Type Description
    IStoreEntityData

    StoreTimedRewardData

    Declaration
    public virtual IStoreTimedRewardData StoreTimedRewardData { get; }
    Property Value
    Type Description
    IStoreTimedRewardData

    StoreTimedRewardSavedData

    Declaration
    public virtual IStoreTimedRewardSavedData StoreTimedRewardSavedData { get; }
    Property Value
    Type Description
    IStoreTimedRewardSavedData

    TimedActivatableData

    Declaration
    public ITimedActivatableData TimedActivatableData { get; }
    Property Value
    Type Description
    ITimedActivatableData

    TimedActivatableSavedData

    Declaration
    public ITimedActivatableSavedData TimedActivatableSavedData { get; }
    Property Value
    Type Description
    ITimedActivatableSavedData

    TimeRemaining

    The duration in milliseconds remaining until the IStoreTimedReward can be claimed

    Declaration
    public virtual long TimeRemaining { get; }
    Property Value
    Type Description
    Int64

    TimerSubscription

    Declaration
    public virtual ITimerSubscription TimerSubscription { get; }
    Property Value
    Type Description
    ITimerSubscription

    Methods

    Activate()

    Declaration
    public void Activate()

    CalculatePayouts()

    Declaration
    public virtual CurrencyAmount[] CalculatePayouts()
    Returns
    Type Description
    CurrencyAmount[]

    CanClaim(Boolean)

    Declaration
    public virtual bool CanClaim(bool ignoreFallback = false)
    Parameters
    Type Name Description
    Boolean ignoreFallback
    Returns
    Type Description
    Boolean

    Claim()

    Declaration
    public virtual void Claim()

    Cleanup(IEntityLoaderService)

    Declaration
    public virtual void Cleanup(IEntityLoaderService entityLoaderService)
    Parameters
    Type Name Description
    IEntityLoaderService entityLoaderService

    Deactivate()

    Declaration
    public void Deactivate()

    Initialize()

    Declaration
    public virtual void Initialize()

    Inject(IResolver)

    Declaration
    public virtual void Inject(IResolver resolver)
    Parameters
    Type Name Description
    IResolver resolver

    OnTimerEnded(Int64)

    Declaration
    public virtual void OnTimerEnded(long count)
    Parameters
    Type Name Description
    Int64 count

    Reset()

    Declaration
    public void Reset()

    SubscribeTimer()

    Declaration
    protected virtual void SubscribeTimer()

    Unlock()

    Declaration
    public virtual bool Unlock()
    Returns
    Type Description
    Boolean

    UnsubscribeTimer()

    Declaration
    protected virtual void UnsubscribeTimer()

    UpdateProgression(Single)

    Declaration
    public virtual void UpdateProgression(float progression)
    Parameters
    Type Name Description
    Single progression

    Implements

    IStoreTimedReward
    IReward
    IPayoutEntity
    IStoreEntity
    ITimedActivatable
    IActivatable
    IEntity
    IInjectable
    ITimerListener
    Back to top Copyright © 2020 East Side Games Inc.