Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / PlayActionView

Interface: PlayActionView ​

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

Fully projected play payload for one card on the action prompt.

Constructed by the action projection layer before the client submits PlayCard.

Example:

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

const playActionView: PlayActionView = {
  "cardInstanceId": 0,
  "cardId": 0,
  "source": {
    "zone": "hand",
  },
  "targetGroups": [],
  "instructedAttack": {
    "attackerIds": [],
  },
  "attachableUnitIds": [],
  "attachmentMode": "none",
  "exploit": {
    "max": 0,
    "candidateUnitIds": [],
  },
  "resourcePaymentOptions": [],
}

console.log(playActionView)

Properties ​

attachableHosts? ​

Example:

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

const playActionView: PlayActionView = {
  "cardInstanceId": 0,
  "cardId": 0,
  "source": {
    "zone": "hand",
  },
  "targetGroups": [],
  "instructedAttack": {
    "attackerIds": [],
  },
  "attachableUnitIds": [],
  "attachmentMode": "none",
  "exploit": {
    "max": 0,
    "candidateUnitIds": [],
  },
  "resourcePaymentOptions": [],
}

const { attachableHosts } = playActionView

console.log(attachableHosts)

optional attachableHosts?: AbilityTarget[]

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

Every legal attachment host. attachable_unit_ids remains for clients that only understand the original unit-host wire field.


attachableUnitIds ​

Example:

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

const playActionView: PlayActionView = {
  "cardInstanceId": 0,
  "cardId": 0,
  "source": {
    "zone": "hand",
  },
  "targetGroups": [],
  "instructedAttack": {
    "attackerIds": [],
  },
  "attachableUnitIds": [],
  "attachmentMode": "none",
  "exploit": {
    "max": 0,
    "candidateUnitIds": [],
  },
  "resourcePaymentOptions": [],
}

const { attachableUnitIds } = playActionView

console.log(attachableUnitIds)

attachableUnitIds: number[]

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


attachmentMode ​

Example:

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

const playActionView: PlayActionView = {
  "cardInstanceId": 0,
  "cardId": 0,
  "source": {
    "zone": "hand",
  },
  "targetGroups": [],
  "instructedAttack": {
    "attackerIds": [],
  },
  "attachableUnitIds": [],
  "attachmentMode": "none",
  "exploit": {
    "max": 0,
    "candidateUnitIds": [],
  },
  "resourcePaymentOptions": [],
}

const { attachmentMode } = playActionView

console.log(attachmentMode)

attachmentMode: AttachmentMode

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


captureOptions? ​

Example:

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

const playActionView: PlayActionView = {
  "cardInstanceId": 0,
  "cardId": 0,
  "source": {
    "zone": "hand",
  },
  "targetGroups": [],
  "instructedAttack": {
    "attackerIds": [],
  },
  "attachableUnitIds": [],
  "attachmentMode": "none",
  "exploit": {
    "max": 0,
    "candidateUnitIds": [],
  },
  "resourcePaymentOptions": [],
}

const { captureOptions } = playActionView

console.log(captureOptions)

optional captureOptions?: CaptureOptionsView | null

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


cardId ​

Example:

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

const playActionView: PlayActionView = {
  "cardInstanceId": 0,
  "cardId": 0,
  "source": {
    "zone": "hand",
  },
  "targetGroups": [],
  "instructedAttack": {
    "attackerIds": [],
  },
  "attachableUnitIds": [],
  "attachmentMode": "none",
  "exploit": {
    "max": 0,
    "candidateUnitIds": [],
  },
  "resourcePaymentOptions": [],
}

const { cardId } = playActionView

console.log(cardId)

cardId: number

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


cardInstanceId ​

Example:

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

const playActionView: PlayActionView = {
  "cardInstanceId": 0,
  "cardId": 0,
  "source": {
    "zone": "hand",
  },
  "targetGroups": [],
  "instructedAttack": {
    "attackerIds": [],
  },
  "attachableUnitIds": [],
  "attachmentMode": "none",
  "exploit": {
    "max": 0,
    "candidateUnitIds": [],
  },
  "resourcePaymentOptions": [],
}

const { cardInstanceId } = playActionView

console.log(cardInstanceId)

cardInstanceId: number

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


exploit ​

Example:

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

const playActionView: PlayActionView = {
  "cardInstanceId": 0,
  "cardId": 0,
  "source": {
    "zone": "hand",
  },
  "targetGroups": [],
  "instructedAttack": {
    "attackerIds": [],
  },
  "attachableUnitIds": [],
  "attachmentMode": "none",
  "exploit": {
    "max": 0,
    "candidateUnitIds": [],
  },
  "resourcePaymentOptions": [],
}

const { exploit } = playActionView

console.log(exploit)

exploit: ExploitOptionsView

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


instructedAttack ​

Example:

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

const playActionView: PlayActionView = {
  "cardInstanceId": 0,
  "cardId": 0,
  "source": {
    "zone": "hand",
  },
  "targetGroups": [],
  "instructedAttack": {
    "attackerIds": [],
  },
  "attachableUnitIds": [],
  "attachmentMode": "none",
  "exploit": {
    "max": 0,
    "candidateUnitIds": [],
  },
  "resourcePaymentOptions": [],
}

const { instructedAttack } = playActionView

console.log(instructedAttack)

instructedAttack: InstructedAttackView

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


modeChoice? ​

Example:

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

const playActionView: PlayActionView = {
  "cardInstanceId": 0,
  "cardId": 0,
  "source": {
    "zone": "hand",
  },
  "targetGroups": [],
  "instructedAttack": {
    "attackerIds": [],
  },
  "attachableUnitIds": [],
  "attachmentMode": "none",
  "exploit": {
    "max": 0,
    "candidateUnitIds": [],
  },
  "resourcePaymentOptions": [],
}

const { modeChoice } = playActionView

console.log(modeChoice)

optional modeChoice?: ModeChoiceView | null

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


resourcePaymentOptions ​

Example:

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

const playActionView: PlayActionView = {
  "cardInstanceId": 0,
  "cardId": 0,
  "source": {
    "zone": "hand",
  },
  "targetGroups": [],
  "instructedAttack": {
    "attackerIds": [],
  },
  "attachableUnitIds": [],
  "attachmentMode": "none",
  "exploit": {
    "max": 0,
    "candidateUnitIds": [],
  },
  "resourcePaymentOptions": [],
}

const { resourcePaymentOptions } = playActionView

console.log(resourcePaymentOptions)

resourcePaymentOptions: ResourcePaymentOptionView[]

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

Exact Credit choices keyed by attachment host and Exploit count.


smuggle? ​

Example:

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

const playActionView: PlayActionView = {
  "cardInstanceId": 0,
  "cardId": 0,
  "source": {
    "zone": "hand",
  },
  "targetGroups": [],
  "instructedAttack": {
    "attackerIds": [],
  },
  "attachableUnitIds": [],
  "attachmentMode": "none",
  "exploit": {
    "max": 0,
    "candidateUnitIds": [],
  },
  "resourcePaymentOptions": [],
}

const { smuggle } = playActionView

console.log(smuggle)

optional smuggle?: SmuggleActionView | null

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


source ​

Example:

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

const playActionView: PlayActionView = {
  "cardInstanceId": 0,
  "cardId": 0,
  "source": {
    "zone": "hand",
  },
  "targetGroups": [],
  "instructedAttack": {
    "attackerIds": [],
  },
  "attachableUnitIds": [],
  "attachmentMode": "none",
  "exploit": {
    "max": 0,
    "candidateUnitIds": [],
  },
  "resourcePaymentOptions": [],
}

const { source } = playActionView

console.log(source)

source: PlayCardSourceView

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


targetGroups ​

Example:

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

const playActionView: PlayActionView = {
  "cardInstanceId": 0,
  "cardId": 0,
  "source": {
    "zone": "hand",
  },
  "targetGroups": [],
  "instructedAttack": {
    "attackerIds": [],
  },
  "attachableUnitIds": [],
  "attachmentMode": "none",
  "exploit": {
    "max": 0,
    "candidateUnitIds": [],
  },
  "resourcePaymentOptions": [],
}

const { targetGroups } = playActionView

console.log(targetGroups)

targetGroups: TargetSelectionGroup[]

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

Released under the MIT License.