Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / PendingAbilityModeChoiceView

Interface: PendingAbilityModeChoiceView ​

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

Example:

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

const pendingAbilityModeChoiceView: PendingAbilityModeChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "optionLabels": [],
}

console.log(pendingAbilityModeChoiceView)

Properties ​

abilityId ​

Example:

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

const pendingAbilityModeChoiceView: PendingAbilityModeChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "optionLabels": [],
}

const { abilityId } = pendingAbilityModeChoiceView

console.log(abilityId)

abilityId: number

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


canDecline? ​

Example:

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

const pendingAbilityModeChoiceView: PendingAbilityModeChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "optionLabels": [],
}

const { canDecline } = pendingAbilityModeChoiceView

console.log(canDecline)

optional canDecline?: boolean | null

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

Whether this active choice may be declined through declineAbility.


inputKind? ​

Example:

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

const pendingAbilityModeChoiceView: PendingAbilityModeChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "optionLabels": [],
}

const { inputKind } = pendingAbilityModeChoiceView

console.log(inputKind)

optional inputKind?: "amount" | null

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

Specialized renderer requested by the engine, absent for ordinary modes.


label ​

Example:

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

const pendingAbilityModeChoiceView: PendingAbilityModeChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "optionLabels": [],
}

const { label } = pendingAbilityModeChoiceView

console.log(label)

label: string

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


max ​

Example:

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

const pendingAbilityModeChoiceView: PendingAbilityModeChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "optionLabels": [],
}

const { max } = pendingAbilityModeChoiceView

console.log(max)

max: number

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


min ​

Example:

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

const pendingAbilityModeChoiceView: PendingAbilityModeChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "optionLabels": [],
}

const { min } = pendingAbilityModeChoiceView

console.log(min)

min: number

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


optionLabels ​

Example:

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

const pendingAbilityModeChoiceView: PendingAbilityModeChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "optionLabels": [],
}

const { optionLabels } = pendingAbilityModeChoiceView

console.log(optionLabels)

optionLabels: string[]

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


optionTextReferences? ​

Example:

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

const pendingAbilityModeChoiceView: PendingAbilityModeChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "optionLabels": [],
}

const { optionTextReferences } = pendingAbilityModeChoiceView

console.log(optionTextReferences)

optional optionTextReferences?: (CardTextRef | null)[]

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

Reviewed printed text for each matching mode option.

Index aligns with option_labels; None denotes an engine/system option rather than inferred prose.


promptProvenance? ​

Example:

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

const pendingAbilityModeChoiceView: PendingAbilityModeChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "optionLabels": [],
}

const { promptProvenance } = pendingAbilityModeChoiceView

console.log(promptProvenance)

optional promptProvenance?: PromptProvenanceView | null

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

Parent/stage identity and interaction policy inherited from resolution.


sourceCardId ​

Example:

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

const pendingAbilityModeChoiceView: PendingAbilityModeChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "optionLabels": [],
}

const { sourceCardId } = pendingAbilityModeChoiceView

console.log(sourceCardId)

sourceCardId: number

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


text? ​

Example:

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

const pendingAbilityModeChoiceView: PendingAbilityModeChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "min": 0,
  "max": 0,
  "optionLabels": [],
}

const { text } = pendingAbilityModeChoiceView

console.log(text)

optional text?: EffectTextRefsView | null

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

Reviewed printed text owning this chooser payload.

Released under the MIT License.