SWU Simulator SDK

Appearance

@my-swu/simulator-client

@my-swu/simulator-client / PendingAbilityCardChoiceView

Interface: PendingAbilityCardChoiceView ​

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

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

console.log(pendingAbilityCardChoiceView)

Properties ​

abilityId ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { abilityId } = pendingAbilityCardChoiceView

console.log(abilityId)

abilityId: number

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

canDecline? ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { canDecline } = pendingAbilityCardChoiceView

console.log(canDecline)

optional canDecline?: boolean | null

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

Whether this active choice may be declined through declineAbility.

candidateCards ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { candidateCards } = pendingAbilityCardChoiceView

console.log(candidateCards)

candidateCards: CardInstanceView[]

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

candidateTargets? ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { candidateTargets } = pendingAbilityCardChoiceView

console.log(candidateTargets)

optional candidateTargets?: AbilityCardChoiceTargetView[]

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

Legal public board/token objects, separate from physical hidden cards.

chooser ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { chooser } = pendingAbilityCardChoiceView

console.log(chooser)

chooser: Seat

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

creditTokenCounts ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { creditTokenCounts } = pendingAbilityCardChoiceView

console.log(creditTokenCounts)

creditTokenCounts: number[]

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

Exact Credit counts accepted with current resource selection.

hiddenCandidateCardInstanceIds? ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { hiddenCandidateCardInstanceIds } = pendingAbilityCardChoiceView

console.log(hiddenCandidateCardInstanceIds)

optional hiddenCandidateCardInstanceIds?: number[]

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

Physical candidates whose card identities remain hidden from chooser.

hiddenZone ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { hiddenZone } = pendingAbilityCardChoiceView

console.log(hiddenZone)

hiddenZone: HiddenZoneKind

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

hiddenZoneOwner ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { hiddenZoneOwner } = pendingAbilityCardChoiceView

console.log(hiddenZoneOwner)

hiddenZoneOwner: Seat

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

inputKind? ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { inputKind } = pendingAbilityCardChoiceView

console.log(inputKind)

optional inputKind?: "eventAlternateCost" | null

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

Structural input contract for specialized card-choice prompts.

label ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { label } = pendingAbilityCardChoiceView

console.log(label)

label: string

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

max ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { max } = pendingAbilityCardChoiceView

console.log(max)

max: number

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

min ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { min } = pendingAbilityCardChoiceView

console.log(min)

min: number

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

promptProvenance? ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { promptProvenance } = pendingAbilityCardChoiceView

console.log(promptProvenance)

optional promptProvenance?: PromptProvenanceView | null

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

Parent/stage identity and interaction policy inherited from resolution.

resourcePaymentOptions? ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { resourcePaymentOptions } = pendingAbilityCardChoiceView

console.log(resourcePaymentOptions)

optional resourcePaymentOptions?: CardChoiceResourcePaymentOptionView[]

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

Exact payment choices keyed by selected card/resource count.

revealMode ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { revealMode } = pendingAbilityCardChoiceView

console.log(revealMode)

revealMode: HiddenCardChoiceMode

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

searchedCards ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { searchedCards } = pendingAbilityCardChoiceView

console.log(searchedCards)

searchedCards: CardInstanceView[]

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

sourceCardId ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { sourceCardId } = pendingAbilityCardChoiceView

console.log(sourceCardId)

sourceCardId: number

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

text? ​

Example:

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

const pendingAbilityCardChoiceView: PendingAbilityCardChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "hiddenZone": "deckSearch",
  "hiddenZoneOwner": "one",
  "chooser": "one",
  "revealMode": "privateLook",
  "searchedCards": [],
  "candidateCards": [],
  "creditTokenCounts": [],
}

const { text } = pendingAbilityCardChoiceView

console.log(text)

optional text?: EffectTextRefsView | null

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

Reviewed printed text owning this private chooser payload.

Released under the MIT License.

Copyright © 2025-present Guillaume Chau