Interface IBoost

A class that provides IModifier functionality that doesn't need to be tied to a specific entity and is, instead, its own entity.

Inherited Members

IEntity.staticDataId

IEntity.instanceId

IEntity.Initialize()

IEntity.Cleanup(IEntityLoaderService)

IModifier.modifierId

IModifier.canBeApplied

IModifier.modifierDataIndex

IModifier.modifierDataCollection

Namespace: IdleKit.Framework

Assembly: cs.temp.dll.dll

Syntax

public interface IBoost : IEntity, IInjectable, IModifier

Properties

boostData

Returns the associated IBoostData.

Declaration

IBoostData boostData { get; }

Property Value

Type	Description
IBoostData

boostSavedData

Returns the associated IBoostSavedData.

Declaration

IBoostSavedData boostSavedData { get; }

Property Value

Type	Description
IBoostSavedData

isActive

Whether or not this IBoost should still be active.

Declaration

bool isActive { get; }

Property Value

Type	Description
Boolean

Methods

Activate()

A call to inform this IBoost that the use has obtained it in some way. The implementation could be a simple boolean flag or something more complicated, such as a timer increment.

Declaration

void Activate()

Deactivate()

Regardless of the Activate() implementation, this call should always provide functionality to cancel/clear the boost.

Declaration

void Deactivate()