Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / LeaderDeployActionView

Interface: LeaderDeployActionView ​

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

Example:

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

const leaderDeployActionView: LeaderDeployActionView = {
  "leaderIndex": 0,
  "cardId": 0,
  "mode": "unit",
}

console.log(leaderDeployActionView)

Properties ​

attachedToUnitId? ​

Example:

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

const leaderDeployActionView: LeaderDeployActionView = {
  "leaderIndex": 0,
  "cardId": 0,
  "mode": "unit",
}

const { attachedToUnitId } = leaderDeployActionView

console.log(attachedToUnitId)

optional attachedToUnitId?: number | null

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

Required host unit id for Pilot deploys; None for unit deploys.


cardId ​

Example:

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

const leaderDeployActionView: LeaderDeployActionView = {
  "leaderIndex": 0,
  "cardId": 0,
  "mode": "unit",
}

const { cardId } = leaderDeployActionView

console.log(cardId)

cardId: number

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

Canonical card id for the leader in this slot.


cost? ​

Example:

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

const leaderDeployActionView: LeaderDeployActionView = {
  "leaderIndex": 0,
  "cardId": 0,
  "mode": "unit",
}

const { cost } = leaderDeployActionView

console.log(cost)

optional cost?: LeaderDeployCostView | null

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

What the unit deploy costs; None for Pilot deploys, which pay the leader's printed Pilot cost instead.


leaderIndex ​

Example:

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

const leaderDeployActionView: LeaderDeployActionView = {
  "leaderIndex": 0,
  "cardId": 0,
  "mode": "unit",
}

const { leaderIndex } = leaderDeployActionView

console.log(leaderIndex)

leaderIndex: number

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

Zero-based leader slot index for the command payload.


mode ​

Example:

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

const leaderDeployActionView: LeaderDeployActionView = {
  "leaderIndex": 0,
  "cardId": 0,
  "mode": "unit",
}

const { mode } = leaderDeployActionView

console.log(mode)

mode: LeaderDeployMode

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

Whether this action deploys as a unit or as a Pilot upgrade.

Released under the MIT License.