Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / PendingAbilityView

Interface: PendingAbilityView ​

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

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

console.log(pendingAbilityView)

Properties ​

canAcceptWithoutInput ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { canAcceptWithoutInput } = pendingAbilityView

console.log(canAcceptWithoutInput)

canAcceptWithoutInput: boolean

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

Whether an optional ability can be explicitly accepted without input.


canDecline? ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { canDecline } = pendingAbilityView

console.log(canDecline)

optional canDecline?: boolean | null

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

Product-level cancellation policy, independent from rules optionality.


captureOptions? ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { captureOptions } = pendingAbilityView

console.log(captureOptions)

optional captureOptions?: CaptureOptionsView | null

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


clauseId? ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { clauseId } = pendingAbilityView

console.log(clauseId)

optional clauseId?: string | null

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

Grant clause that authored this ability, mirrored from the granting upgrade's ability inventory. None for a card's own printed clause.


effectSequence? ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { effectSequence } = pendingAbilityView

console.log(effectSequence)

optional effectSequence?: EffectSequenceView | null

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

Identifies a player-confirmed stage within one multi-effect ability.


exploit? ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { exploit } = pendingAbilityView

console.log(exploit)

optional exploit?: ExploitOptionsView | null

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


family ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { family } = pendingAbilityView

console.log(family)

family: PendingAbilityFamily

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

Which kind of pending ability this is, without its payload.

Separates two abilities that share a card and a window — for instance Ambush and a When Played clause queued together.


id ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { id } = pendingAbilityView

console.log(id)

id: number

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


label ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { label } = pendingAbilityView

console.log(label)

label: string

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


optional ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { optional } = pendingAbilityView

console.log(optional)

optional: boolean

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


promptProvenance? ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { promptProvenance } = pendingAbilityView

console.log(promptProvenance)

optional promptProvenance?: PromptProvenanceView | null

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

Parent/stage identity and interaction policy inherited from resolution.


resourcePaymentOptions? ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { resourcePaymentOptions } = pendingAbilityView

console.log(resourcePaymentOptions)

optional resourcePaymentOptions?: ResourcePaymentOptionView[] | null

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

Exact Credit choices for a Plot play, keyed by selected Upgrade host and Exploit count. None means this pending ability has no resource payment.


sourceCardId ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { sourceCardId } = pendingAbilityView

console.log(sourceCardId)

sourceCardId: number

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


sourceUnitId? ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { sourceUnitId } = pendingAbilityView

console.log(sourceUnitId)

optional sourceUnitId?: number | null

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


targetPlan ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { targetPlan } = pendingAbilityView

console.log(targetPlan)

targetPlan: TargetSelectionPlanView

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

Complete target-selection contract for this pending ability.

Groups retain ordering, bounds, and structural purpose together.


text? ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { text } = pendingAbilityView

console.log(text)

optional text?: EffectTextRefsView | null

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

Reviewed printed ability, selected mode, and current effect ownership.


window ​

Example:

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

const pendingAbilityView: PendingAbilityView = {
  "id": 0,
  "sourceCardId": 0,
  "window": "AfterPlayOrDeploy",
  "family": "Shielded",
  "label": 'example',
  "optional": false,
  "canAcceptWithoutInput": false,
  "targetPlan": {
    "groups": [],
  },
}

const { window } = pendingAbilityView

console.log(window)

window: AbilityWindow

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

Trigger window this ability was collected in.

Part of the ability's stable identity: with source_card_id, source_unit_id, clause_id, and family it addresses one queued ability without depending on queue position.

Released under the MIT License.