Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / TargetSelectionGroup

Interface: TargetSelectionGroup ​

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

Example:

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

const targetSelectionGroup: TargetSelectionGroup = {
  "validTargets": [],
  "min": 0,
  "max": 0,
  "distinct": false,
}

console.log(targetSelectionGroup)

Properties ​

clauseId? ​

Example:

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

const targetSelectionGroup: TargetSelectionGroup = {
  "validTargets": [],
  "min": 0,
  "max": 0,
  "distinct": false,
}

const { clauseId } = targetSelectionGroup

console.log(clauseId)

optional clauseId?: number | null

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

Stable, per-ability identifier for the clause this group belongs to.

For multi-group abilities the engine assigns an ascending index (0-based) in group order. Single-group abilities leave this None.


distinct ​

Example:

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

const targetSelectionGroup: TargetSelectionGroup = {
  "validTargets": [],
  "min": 0,
  "max": 0,
  "distinct": false,
}

const { distinct } = targetSelectionGroup

console.log(distinct)

distinct: boolean

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


max ​

Example:

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

const targetSelectionGroup: TargetSelectionGroup = {
  "validTargets": [],
  "min": 0,
  "max": 0,
  "distinct": false,
}

const { max } = targetSelectionGroup

console.log(max)

max: number

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


min ​

Example:

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

const targetSelectionGroup: TargetSelectionGroup = {
  "validTargets": [],
  "min": 0,
  "max": 0,
  "distinct": false,
}

const { min } = targetSelectionGroup

console.log(min)

min: number

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


purpose? ​

Example:

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

const targetSelectionGroup: TargetSelectionGroup = {
  "validTargets": [],
  "min": 0,
  "max": 0,
  "distinct": false,
}

const { purpose } = targetSelectionGroup

console.log(purpose)

optional purpose?: TargetGroupPurpose | null

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

Structural purpose of this individual target group, so the UI can render a localized per-clause label instead of parsing printed card text.

Populated from the typed effect variant that produced the group. Single- group abilities also carry a purpose. None only when the producing effect requests targets but has no classifiable structural meaning.


textReferences? ​

Example:

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

const targetSelectionGroup: TargetSelectionGroup = {
  "validTargets": [],
  "min": 0,
  "max": 0,
  "distinct": false,
}

const { textReferences } = targetSelectionGroup

console.log(textReferences)

optional textReferences?: CardTextRef[]

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

Reviewed printed text that produced this exact group.

References are locale-neutral and preserve nested printed-effect ownership without placing card prose in public match state.


validTargets ​

Example:

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

const targetSelectionGroup: TargetSelectionGroup = {
  "validTargets": [],
  "min": 0,
  "max": 0,
  "distinct": false,
}

const { validTargets } = targetSelectionGroup

console.log(validTargets)

validTargets: AbilityTarget[]

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

Released under the MIT License.