SWU Simulator SDK

Appearance

@my-swu/simulator-client

@my-swu/simulator-client / PendingDistributionView

Interface: PendingDistributionView ​

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

Example:

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

const pendingDistributionView: PendingDistributionView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "chooser": "one",
  "title": 'example',
  "item": {
    "type": "damage",
    "kind": "indirect",
  },
  "minAmount": 0,
  "maxAmount": 0,
  "validTargets": [],
  "chosenAssignments": [],
}

console.log(pendingDistributionView)

Properties ​

abilityId ​

Example:

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

const pendingDistributionView: PendingDistributionView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "chooser": "one",
  "title": 'example',
  "item": {
    "type": "damage",
    "kind": "indirect",
  },
  "minAmount": 0,
  "maxAmount": 0,
  "validTargets": [],
  "chosenAssignments": [],
}

const { abilityId } = pendingDistributionView

console.log(abilityId)

abilityId: number

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

allOrNone? ​

Example:

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

const pendingDistributionView: PendingDistributionView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "chooser": "one",
  "title": 'example',
  "item": {
    "type": "damage",
    "kind": "indirect",
  },
  "minAmount": 0,
  "maxAmount": 0,
  "validTargets": [],
  "chosenAssignments": [],
}

const { allOrNone } = pendingDistributionView

console.log(allOrNone)

optional allOrNone?: boolean

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

Whether an accepted assignment must total exactly max_amount.

min_amount ..= max_amount alone cannot state the all-or-nothing shape CR 8.4.5 gives divided damage: "the player must deal all damage specified by the ability", while CR 8.4.5.a still lets a "divided among any number of units" printing deal to 0 units. Those two together make {0, max_amount} legal and every partial total illegal — a range of 0 ..= max_amount reads as "anything in between is fine", and a client that believed it would compose totals the engine rejects (Overwhelming Barrage 340, Hold Them Off 52376, Ninth Sister 52421, Helgait 52656).

With this flag set, the legal answers are exactly: max_amount, plus the empty assignment when min_amount is 0. false keeps the plain range reading, which is why it is also the decode default for snapshots written before this field existed.

canDecline? ​

Example:

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

const pendingDistributionView: PendingDistributionView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "chooser": "one",
  "title": 'example',
  "item": {
    "type": "damage",
    "kind": "indirect",
  },
  "minAmount": 0,
  "maxAmount": 0,
  "validTargets": [],
  "chosenAssignments": [],
}

const { canDecline } = pendingDistributionView

console.log(canDecline)

optional canDecline?: boolean | null

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

Whether this active choice may be declined through declineAbility.

chooser ​

Example:

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

const pendingDistributionView: PendingDistributionView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "chooser": "one",
  "title": 'example',
  "item": {
    "type": "damage",
    "kind": "indirect",
  },
  "minAmount": 0,
  "maxAmount": 0,
  "validTargets": [],
  "chosenAssignments": [],
}

const { chooser } = pendingDistributionView

console.log(chooser)

chooser: Seat

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

chosenAssignments ​

Example:

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

const pendingDistributionView: PendingDistributionView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "chooser": "one",
  "title": 'example',
  "item": {
    "type": "damage",
    "kind": "indirect",
  },
  "minAmount": 0,
  "maxAmount": 0,
  "validTargets": [],
  "chosenAssignments": [],
}

const { chosenAssignments } = pendingDistributionView

console.log(chosenAssignments)

chosenAssignments: DistributionAssignment[]

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

item ​

Example:

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

const pendingDistributionView: PendingDistributionView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "chooser": "one",
  "title": 'example',
  "item": {
    "type": "damage",
    "kind": "indirect",
  },
  "minAmount": 0,
  "maxAmount": 0,
  "validTargets": [],
  "chosenAssignments": [],
}

const { item } = pendingDistributionView

console.log(item)

item: DistributionItemView

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

maxAmount ​

Example:

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

const pendingDistributionView: PendingDistributionView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "chooser": "one",
  "title": 'example',
  "item": {
    "type": "damage",
    "kind": "indirect",
  },
  "minAmount": 0,
  "maxAmount": 0,
  "validTargets": [],
  "chosenAssignments": [],
}

const { maxAmount } = pendingDistributionView

console.log(maxAmount)

maxAmount: number

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

minAmount ​

Example:

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

const pendingDistributionView: PendingDistributionView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "chooser": "one",
  "title": 'example',
  "item": {
    "type": "damage",
    "kind": "indirect",
  },
  "minAmount": 0,
  "maxAmount": 0,
  "validTargets": [],
  "chosenAssignments": [],
}

const { minAmount } = pendingDistributionView

console.log(minAmount)

minAmount: number

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

promptProvenance? ​

Example:

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

const pendingDistributionView: PendingDistributionView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "chooser": "one",
  "title": 'example',
  "item": {
    "type": "damage",
    "kind": "indirect",
  },
  "minAmount": 0,
  "maxAmount": 0,
  "validTargets": [],
  "chosenAssignments": [],
}

const { promptProvenance } = pendingDistributionView

console.log(promptProvenance)

optional promptProvenance?: PromptProvenanceView | null

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

Parent/stage identity and interaction policy inherited from resolution.

sourceCardId ​

Example:

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

const pendingDistributionView: PendingDistributionView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "chooser": "one",
  "title": 'example',
  "item": {
    "type": "damage",
    "kind": "indirect",
  },
  "minAmount": 0,
  "maxAmount": 0,
  "validTargets": [],
  "chosenAssignments": [],
}

const { sourceCardId } = pendingDistributionView

console.log(sourceCardId)

sourceCardId: number

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

text? ​

Example:

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

const pendingDistributionView: PendingDistributionView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "chooser": "one",
  "title": 'example',
  "item": {
    "type": "damage",
    "kind": "indirect",
  },
  "minAmount": 0,
  "maxAmount": 0,
  "validTargets": [],
  "chosenAssignments": [],
}

const { text } = pendingDistributionView

console.log(text)

optional text?: EffectTextRefsView | null

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

Reviewed printed text owning this chooser payload.

title ​

Example:

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

const pendingDistributionView: PendingDistributionView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "chooser": "one",
  "title": 'example',
  "item": {
    "type": "damage",
    "kind": "indirect",
  },
  "minAmount": 0,
  "maxAmount": 0,
  "validTargets": [],
  "chosenAssignments": [],
}

const { title } = pendingDistributionView

console.log(title)

title: string

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

validTargets ​

Example:

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

const pendingDistributionView: PendingDistributionView = {
  "abilityId": 0,
  "sourceCardId": 0,
  "chooser": "one",
  "title": 'example',
  "item": {
    "type": "damage",
    "kind": "indirect",
  },
  "minAmount": 0,
  "maxAmount": 0,
  "validTargets": [],
  "chosenAssignments": [],
}

const { validTargets } = pendingDistributionView

console.log(validTargets)

validTargets: DistributionTargetView[]

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

Released under the MIT License.

Copyright © 2025-present Guillaume Chau