Class BonusEffect

Abstract base class for bonus effects. Defines how a value is transformed. Subclasses implement specific transformation logic.

Inheritance
System.Object
BonusEffect
BonusEffectAdditive
BonusEffectCappedMultiplicative
BonusEffectChance
BonusEffectDiminishing
BonusEffectMultiplicative
BonusEffectOverride
BonusEffectSkillMultiplier
Implements
Namespace: Eco.Gameplay.Bonuses
Assembly: Eco.Gameplay.dll
Syntax
public abstract class BonusEffect : Object, IDescribable

Constructors

BonusEffect()

Declaration
protected BonusEffect()

Properties

LowerIsBetter

Declaration
public bool LowerIsBetter { get; set; }
Property Value
Type Description
System.Boolean

OrderOfOperations

Order in which this effect is applied. Lower values are applied first. Default: 0. Multiplicative effects typically use -1, overrides use 1.

Declaration
public virtual float OrderOfOperations { get; }
Property Value
Type Description
System.Single

ScalesWithTalentLevel

Whether this effect scales with SourceLevel (talent level). Used to determine if a talent is upgradeable.

Declaration
public virtual bool ScalesWithTalentLevel { get; }
Property Value
Type Description
System.Boolean

Methods

Description(BonusContext)

Describe the effect. Context may be null (generic description) or set (context-aware, showing current-level values).

Declaration
public abstract LocString Description(BonusContext context = null)
Parameters
Type Name Description
BonusContext context
Returns
Type Description
LocString

TransformValue(BonusContext, Single)

Transform the input value according to this effect's logic.

Declaration
public abstract float TransformValue(BonusContext context, float value)
Parameters
Type Name Description
BonusContext context
System.Single value
Returns
Type Description
System.Single

Explicit Interface Implementations

IDescribable.Description()

Satisfies IDescribable — delegates to Description(BonusContext) with null context.

Declaration
LocString IDescribable.Description()
Returns
Type Description
LocString

Implements

Extension Methods