Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / PendingAbilityFamily

Type Alias: PendingAbilityFamily ​

PendingAbilityFamily = "Shielded" | "Ambush" | "Plot" | "EffectPlot" | "Restore" | "Saboteur" | "UniqueRule" | "SetAttackCombatOrder" | "ChooseBountyCollector" | "PilotUpgradeDefeatReplacement" | "LeaderDeployCost" | "TriggeredContinuation" | "Triggered" | "Pending" | "Resume" | "EndlessLegionsContinue" | "StolenLandspeeder6111Bounty" | "GarSaxon7888ReturnAttachedUpgrades"

Defined in: packages/ts-sdk/src/generated/types/common.ts:4549

Coarse family of one pending ability: [PendingAbilityKind]'s variant without its payload.

Queue position is presentation order, so a caller that needs to address one specific queued ability names it by identity instead. Two abilities can share a source card and a trigger window and still be different abilities — Snub Fighter Squadron (52651) queues its Ambush and its When Played damage together in AfterPlayOrDeploy — and the family is what tells them apart.

The mapping is exhaustive on purpose: a new [PendingAbilityKind] variant must declare its family here rather than silently collapsing into another.

Example:

ts
import type { PendingAbilityFamily } from '@my-swu/simulator-client'

const pendingAbilityFamily: PendingAbilityFamily = "Shielded"

console.log(pendingAbilityFamily)

Released under the MIT License.