Class BaseCollectorEntity

Inheritance

Object

BaseCollectorEntity

CollectorEntity

GeneratorEntity

Implements

IBaseCollectorEntity

IEntity

IInjectable

IModifiable

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 abstract class BaseCollectorEntity : IBaseCollectorEntity, IEntity, IInjectable, IModifiable

Constructors

BaseCollectorEntity(String)

Declaration

protected BaseCollectorEntity(string id)

Parameters

Type	Name	Description
String	id

Fields

_actionService

Declaration

protected IActionService _actionService

Field Value

Type	Description
IActionService

_baseCollectorBalanceData

Declaration

protected IBaseCollectorBalanceData _baseCollectorBalanceData

Field Value

Type	Description
IBaseCollectorBalanceData

_baseCollectorData

Declaration

protected IBaseCollectorData _baseCollectorData

Field Value

Type	Description
IBaseCollectorData

_baseCollectorEntityData

Declaration

protected IBaseCollectorEntityData _baseCollectorEntityData

Field Value

Type	Description
IBaseCollectorEntityData

_baseCollectorEntitySavedData

Declaration

protected IBaseCollectorEntitySavedData _baseCollectorEntitySavedData

Field Value

Type	Description
IBaseCollectorEntitySavedData

_collectMultiplier

Declaration

protected long _collectMultiplier

Field Value

Type	Description
Int64

_currencyService

Declaration

protected ICurrencyService _currencyService

Field Value

Type	Description
ICurrencyService

_dataService

Declaration

protected IDataService _dataService

Field Value

Type	Description
IDataService

_durationCache

Declaration

protected long _durationCache

Field Value

Type	Description
Int64

_generatorState

Declaration

protected IGeneratorState _generatorState

Field Value

Type	Description
IGeneratorState

_generatorStates

Declaration

protected readonly Dictionary<Type, IGeneratorState> _generatorStates

Field Value

Type	Description
Dictionary<Type, IGeneratorState>

_id

Declaration

protected readonly string _id

Field Value

Type	Description
String

_minimumDuration

Declaration

protected long _minimumDuration

Field Value

Type	Description
Int64

_modifierService

Declaration

protected IModifierService _modifierService

Field Value

Type	Description
IModifierService

_payoutAmountCache

Declaration

protected double _payoutAmountCache

Field Value

Type	Description
Double

_payoutEntity

Declaration

protected IPayoutEntity _payoutEntity

Field Value

Type	Description
IPayoutEntity

Properties

BaseCollectorBalanceData

Declaration

public virtual IBaseCollectorBalanceData BaseCollectorBalanceData { get; }

Property Value

Type	Description
IBaseCollectorBalanceData

BaseCollectorData

Declaration

public virtual IBaseCollectorData BaseCollectorData { get; }

Property Value

Type	Description
IBaseCollectorData

BaseCollectorEntityData

Declaration

public virtual IBaseCollectorEntityData BaseCollectorEntityData { get; }

Property Value

Type	Description
IBaseCollectorEntityData

BaseCollectorEntitySavedData

Declaration

public virtual IBaseCollectorEntitySavedData BaseCollectorEntitySavedData { get; }

Property Value

Type	Description
IBaseCollectorEntitySavedData

CollectMultiplier

Declaration

public long CollectMultiplier { get; }

Property Value

Type	Description
Int64

CostToBuy

Declaration

public virtual double CostToBuy { get; }

Property Value

Type	Description
Double

Duration

Declaration

public virtual long Duration { get; }

Property Value

Type	Description
Int64

GeneratorState

Declaration

public virtual IGeneratorState GeneratorState { get; }

Property Value

Type	Description
IGeneratorState

GeneratorStateType

Declaration

public virtual string GeneratorStateType { get; }

Property Value

Type	Description
String

Id

Declaration

public virtual string Id { get; }

Property Value

Type	Description
String

MinimumDuration

Declaration

public virtual long MinimumDuration { get; }

Property Value

Type	Description
Int64

ModifiableData

Declaration

public virtual IModifiableData ModifiableData { get; }

Property Value

Type	Description
IModifiableData

PayoutAmount

Declaration

public virtual double PayoutAmount { get; }

Property Value

Type	Description
Double

PayoutEntity

Declaration

public virtual IPayoutEntity PayoutEntity { get; }

Property Value

Type	Description
IPayoutEntity

Methods

Buy()

Declaration

public abstract void Buy()

CanBuy()

Declaration

public virtual bool CanBuy()

Returns

Type	Description
Boolean

CanCollect()

Declaration

public virtual bool CanCollect()

Returns

Type	Description
Boolean

ChangeState<TState>()

Declaration

public virtual void ChangeState<TState>()
    where TState : IGeneratorState

Type Parameters

Name	Description
TState

Cleanup(IEntityLoaderService)

Declaration

public virtual void Cleanup(IEntityLoaderService entityLoaderService)

Parameters

Type	Name	Description
IEntityLoaderService	entityLoaderService

Collect(Int64)

Declaration

public abstract void Collect(long count = 1L)

Parameters

Type	Name	Description
Int64	count

GetDuration(Boolean, IModifier[])

This method calculates and returns the value of Duration The return value can be the BaseDuration, MinimumDuration or the modified speed If the resulting value is below MinimumDuration the Duration can not reflect this speed and it will be set to MinimumDuration The CollectMultiplier is how much the payout amount will be increased based on (MinimumDuration / speed) If MinimumDuration = 1m and speed = 0.5 Collector Multiplier will hold the value of two which will multiply the PayoutAmount

Declaration

public virtual long GetDuration(bool applyModifiers, IModifier[] excludedModifiers = null)

Parameters

Type	Name	Description
Boolean	applyModifiers
IModifier[]	excludedModifiers

Returns

Type	Description
Int64

GetModifiedPayout(ref Double, IModifier[])

Declaration

protected abstract void GetModifiedPayout(ref double payout, IModifier[] excludedModifiers)

Parameters

Type	Name	Description
Double	payout
IModifier[]	excludedModifiers

GetModifiedSpeed(ref Double, IModifier[])

Declaration

protected abstract void GetModifiedSpeed(ref double speed, IModifier[] excludedModifiers)

Parameters

Type	Name	Description
Double	speed
IModifier[]	excludedModifiers

GetPayoutAmount(Boolean, IModifier[])

Declaration

public virtual double GetPayoutAmount(bool applyModifiers, IModifier[] excludedModifiers = null)

Parameters

Type	Name	Description
Boolean	applyModifiers
IModifier[]	excludedModifiers

Returns

Type	Description
Double

GetUnmodifiedPayout()

Declaration

protected abstract double GetUnmodifiedPayout()

Returns

Type	Description
Double

InitGeneratorState()

Declaration

protected virtual void InitGeneratorState()

Initialize()

Declaration

public virtual void Initialize()

Inject(IResolver)

Declaration

public virtual void Inject(IResolver resolver)

Parameters

Type	Name	Description
IResolver	resolver

IsBought()

Declaration

public virtual bool IsBought()

Returns

Type	Description
Boolean

MeetsBuyCosts()

Declaration

protected virtual bool MeetsBuyCosts()

Returns

Type	Description
Boolean

MeetsBuyUnlockRequirements()

Declaration

public virtual bool MeetsBuyUnlockRequirements()

Returns

Type	Description
Boolean

ModifierAffectsCategoryType<TModifierFormula>(IModifier)

Declaration

protected virtual bool ModifierAffectsCategoryType<TModifierFormula>(IModifier modifier)
    where TModifierFormula : class, IModifierFormula

Parameters

Type	Name	Description
IModifier	modifier

Returns

Type	Description
Boolean

Type Parameters

Name	Description
TModifierFormula

ModifierAffectsPay(IModifier)

Declaration

protected abstract bool ModifierAffectsPay(IModifier modifier)

Parameters

Type	Name	Description
IModifier	modifier

Returns

Type	Description
Boolean

ModifierAffectsSpeed(IModifier)

Declaration

protected abstract bool ModifierAffectsSpeed(IModifier modifier)

Parameters

Type	Name	Description
IModifier	modifier

Returns

Type	Description
Boolean

OnModifierAction(ModifierAction)

Declaration

protected virtual void OnModifierAction(ModifierAction modifierAction)

Parameters

Type	Name	Description
ModifierAction	modifierAction

RefreshCache()

Declaration

protected virtual void RefreshCache()

RefreshPayout()

Declaration

protected virtual void RefreshPayout()

RefreshSpeed()

Declaration

protected virtual void RefreshSpeed()

SendPayoutChangedAction(Double)

Declaration

protected abstract void SendPayoutChangedAction(double previousPayout)

Parameters

Type	Name	Description
Double	previousPayout

SendSpeedChangedAction(Int64)

Declaration

protected abstract void SendSpeedChangedAction(long previousSpeed)

Parameters

Type	Name	Description
Int64	previousSpeed

SendStateChangedAction(IGeneratorState)

Declaration

protected abstract void SendStateChangedAction(IGeneratorState previousState)

Parameters

Type	Name	Description
IGeneratorState	previousState

Implements

IBaseCollectorEntity

IEntity

IInjectable

IModifiable