Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / PendingAbilityAttackChoiceView

Interface: PendingAbilityAttackChoiceView ​

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

Example:

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

const pendingAbilityAttackChoiceView: PendingAbilityAttackChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "optional": false,
  "attackOptions": [],
}

console.log(pendingAbilityAttackChoiceView)

Properties ​

abilityId ​

Example:

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

const pendingAbilityAttackChoiceView: PendingAbilityAttackChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "optional": false,
  "attackOptions": [],
}

const { abilityId } = pendingAbilityAttackChoiceView

console.log(abilityId)

abilityId: number

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


attackOptions ​

Example:

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

const pendingAbilityAttackChoiceView: PendingAbilityAttackChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "optional": false,
  "attackOptions": [],
}

const { attackOptions } = pendingAbilityAttackChoiceView

console.log(attackOptions)

attackOptions: AttackChoiceView[]

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


canDecline? ​

Example:

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

const pendingAbilityAttackChoiceView: PendingAbilityAttackChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "optional": false,
  "attackOptions": [],
}

const { canDecline } = pendingAbilityAttackChoiceView

console.log(canDecline)

optional canDecline?: boolean | null

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

Whether this active choice may be declined through declineAbility.


clauseId? ​

Example:

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

const pendingAbilityAttackChoiceView: PendingAbilityAttackChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "optional": false,
  "attackOptions": [],
}

const { clauseId } = pendingAbilityAttackChoiceView

console.log(clauseId)

optional clauseId?: number | null

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

Clause identifier matching target-group metadata; absent for this single choice.


label ​

Example:

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

const pendingAbilityAttackChoiceView: PendingAbilityAttackChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "optional": false,
  "attackOptions": [],
}

const { label } = pendingAbilityAttackChoiceView

console.log(label)

label: string

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


optional ​

Example:

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

const pendingAbilityAttackChoiceView: PendingAbilityAttackChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "optional": false,
  "attackOptions": [],
}

const { optional } = pendingAbilityAttackChoiceView

console.log(optional)

optional: boolean

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


promptProvenance? ​

Example:

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

const pendingAbilityAttackChoiceView: PendingAbilityAttackChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "optional": false,
  "attackOptions": [],
}

const { promptProvenance } = pendingAbilityAttackChoiceView

console.log(promptProvenance)

optional promptProvenance?: PromptProvenanceView | null

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

Parent/stage identity and interaction policy inherited from resolution.


purpose? ​

Example:

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

const pendingAbilityAttackChoiceView: PendingAbilityAttackChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "optional": false,
  "attackOptions": [],
}

const { purpose } = pendingAbilityAttackChoiceView

console.log(purpose)

optional purpose?: TargetGroupPurpose | null

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

Structural purpose of choosing an attacker through this specialized prompt.


revealedCardIds? ​

Example:

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

const pendingAbilityAttackChoiceView: PendingAbilityAttackChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "optional": false,
  "attackOptions": [],
}

const { revealedCardIds } = pendingAbilityAttackChoiceView

console.log(revealedCardIds)

optional revealedCardIds?: number[]

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

Publicly revealed cards which caused this instructed attack. Omitted for ordinary attacks and intentionally projected only to chooser.


sourceCardId ​

Example:

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

const pendingAbilityAttackChoiceView: PendingAbilityAttackChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "optional": false,
  "attackOptions": [],
}

const { sourceCardId } = pendingAbilityAttackChoiceView

console.log(sourceCardId)

sourceCardId: number

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


text? ​

Example:

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

const pendingAbilityAttackChoiceView: PendingAbilityAttackChoiceView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "label": 'example',
  "optional": false,
  "attackOptions": [],
}

const { text } = pendingAbilityAttackChoiceView

console.log(text)

optional text?: EffectTextRefsView | null

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

Reviewed printed text owning this chooser payload.

Released under the MIT License.