Class AbilityView

constructor

• new AbilityView(raw: AbilityDSLEntry, ds: Dataset): AbilityView

  Parameters

  • raw: AbilityDSLEntry

    The full generated ability record.

  • ds: Dataset

  Returns AbilityView

Readonlyraw

id

• get id(): string

  The ability's id (ability_id in the raw record).

  Returns string

name

• get name(): string

  Returns string

phases

• get phases(): Phase[]

  Game phases this ability acts in, unioned across its phase-mappings.

  Returns Phase[]

units

• get units(): UnitView[]

  Units that list this ability in their ability_ids.

  Returns UnitView[]

appliesTo

• get appliesTo(): AbilityAppliesTo | undefined

  The curated applies_to keyword filter, or undefined when this ability declares no resolvable unit scope. When present, it names which datasheet units the ability benefits — the contract for roster-side highlighting (e.g. a detachment rule that only buffs POSSESSED units).

  Returns AbilityAppliesTo | undefined

describe

• describe(): string

  Generated plain-English approximation of this ability's effect + scope, rendered from the DSL by the conformance-pinned describer (translate/effect.ts). The dataset carries no rules prose; this is the displayable stand-in.

  Returns string

affectsUnit

• affectsUnit(unit: UnitView): boolean

  Whether this ability's applies_to scope includes unit — true iff the unit carries every required_keywords entry and no excluded_keywords, across its keywords + faction_keywords. Always false when the ability has no applies_to (no resolvable scope → no highlight). Pinned by the conformance/applies-to corpus.

  Parameters

  • unit: UnitView

  Returns boolean

affectedUnits

• affectedUnits(candidates: UnitView[]): UnitView[]

  The subset of candidates (typically a roster's units) this ability's applies_to scope benefits, preserving input order. Empty when the ability declares no scope.

  Parameters

  • candidates: UnitView[]

  Returns UnitView[]

getBuffs

• getBuffs(
      source: BuffSource,
      context?: EngineContext,
      perspective?: TranslationPerspective,
  ): Buff[]

  Buff stack this ability contributes against context, with provenance tagged via source (the caller knows whether this ability is being read as army, detachment, unit, leader, etc.). DSL branches the buff layer can't auto-apply are dropped here; call describeBuffs if you also want the diagnostics. perspective defaults to "attacker"; pass "target" to translate the ability as a defensive buff (FNP, T/Sv stat-mods, save rerolls, incoming hit penalties).

  Parameters

  • source: BuffSource
  • Optionalcontext: EngineContext
  • perspective: TranslationPerspective = "attacker"

  Returns Buff[]

describeBuffs

• describeBuffs(
      source: BuffSource,
      context?: EngineContext,
      perspective?: TranslationPerspective,
  ): EffectTranslation

  Full DSL→Buff translation, including the unsupported list of effect fragments the buff layer can't model. The SPA renders these as warnings so users see which abilities have effects that need a manual toggle.

  Parameters

  • source: BuffSource
  • Optionalcontext: EngineContext
  • perspective: TranslationPerspective = "attacker"

  Returns EffectTranslation