Class ValueDelta

constructor

• new ValueDelta(
      data?: Partial<sohl.entity.modifier.ValueDelta.Data>,
      options?: Partial<sohl.entity.modifier.ValueDelta.Options>,
  ): sohl.entity.modifier.ValueDelta

• Constructs a value delta, normalizing value to a string and validating that non-CUSTOM operators receive a numeric value.

  Parameters

  • data: Partial<sohl.entity.modifier.ValueDelta.Data> = {}

    Delta construction data.

    • name

      Localization key naming the delta's source (see label).

    • abbrev

      Short abbreviation for the delta's source.

    • op

      The operator selecting how the delta combines with the value.

    • value

      The delta's value (numeric, or a boolean flag).

  • options: Partial<sohl.entity.modifier.ValueDelta.Options> = {}

    Construction options.

    • parent

      The owning sohl.core.logic.SohlLogic.

  Returns sohl.entity.modifier.ValueDelta

  Throws

  TypeError if a non-CUSTOM operator is given a non-numeric value.

abbrev

name

op

value

label

• get label(): string

• The delta's source name localized for display.

  name is a localization key by convention across the system (SOHL.ValueDelta.INFO.*, SOHL.MOD.*, SOHL.MysticalAbility.*, …), so anything surfacing it to a human must localize it here rather than emitting the raw key (#1127) — the same treatment sohl.entity.modifier.ValueModifier.disabledReason got in #948. Idempotent on already-plain text: an unknown key localizes to itself, so an ad-hoc delta named with prose passes through unchanged.

  Returns string

numValue

• get numValue(): number

• The value as a number — "true"→1, "false"→0, otherwise the parsed number (0 if NaN).

  Returns number

apply

• apply(base: number): number

• Apply this delta to a base value according to its op.

  Parameters

  • base: number

    The running value to modify.

  Returns number

  The resulting value.

  Throws

  TypeError if op is not a valid operator.

toJSON

• toJSON(): PlainObject

• Serialize this delta to a plain object.

  Returns PlainObject

  A plain-object representation of this delta.