@my-swu/simulator-client / LeaderDeployCostView
Interface: LeaderDeployCostView
Defined in: packages/ts-sdk/src/generated/types/common.ts:2764
What deploying a leader as a unit costs.
Rendered from the same rule the engine charges, so a client can explain a greyed-out deploy instead of guessing at the printed Epic Action text.
Example:
import type { LeaderDeployCostView } from '@my-swu/simulator-client'
const leaderDeployCostView: LeaderDeployCostView = {
"resourceThreshold": 0,
"thresholdBonus": "none",
"exhaustResources": 0,
"discardCards": 0,
"exhaustLeader": false,
}
console.log(leaderDeployCostView)Properties
discardCards
Example:
import type { LeaderDeployCostView } from '@my-swu/simulator-client'
const leaderDeployCostView: LeaderDeployCostView = {
"resourceThreshold": 0,
"thresholdBonus": "none",
"exhaustResources": 0,
"discardCards": 0,
"exhaustLeader": false,
}
const { discardCards } = leaderDeployCostView
console.log(discardCards)discardCards:
number
Defined in: packages/ts-sdk/src/generated/types/common.ts:2768
Cards discarded from hand as payment.
exhaustLeader
Example:
import type { LeaderDeployCostView } from '@my-swu/simulator-client'
const leaderDeployCostView: LeaderDeployCostView = {
"resourceThreshold": 0,
"thresholdBonus": "none",
"exhaustResources": 0,
"discardCards": 0,
"exhaustLeader": false,
}
const { exhaustLeader } = leaderDeployCostView
console.log(exhaustLeader)exhaustLeader:
boolean
Defined in: packages/ts-sdk/src/generated/types/common.ts:2772
Whether the leader exhausts itself as part of the cost.
exhaustResources
Example:
import type { LeaderDeployCostView } from '@my-swu/simulator-client'
const leaderDeployCostView: LeaderDeployCostView = {
"resourceThreshold": 0,
"thresholdBonus": "none",
"exhaustResources": 0,
"discardCards": 0,
"exhaustLeader": false,
}
const { exhaustResources } = leaderDeployCostView
console.log(exhaustResources)exhaustResources:
number
Defined in: packages/ts-sdk/src/generated/types/common.ts:2776
Ready resources exhausted as payment.
resourceThreshold
Example:
import type { LeaderDeployCostView } from '@my-swu/simulator-client'
const leaderDeployCostView: LeaderDeployCostView = {
"resourceThreshold": 0,
"thresholdBonus": "none",
"exhaustResources": 0,
"discardCards": 0,
"exhaustLeader": false,
}
const { resourceThreshold } = leaderDeployCostView
console.log(resourceThreshold)resourceThreshold:
number
Defined in: packages/ts-sdk/src/generated/types/common.ts:2781
Resources the player must control before the deploy is legal. This is a threshold, not a payment: controlling them is the condition (CR §573).
thresholdBonus
Example:
import type { LeaderDeployCostView } from '@my-swu/simulator-client'
const leaderDeployCostView: LeaderDeployCostView = {
"resourceThreshold": 0,
"thresholdBonus": "none",
"exhaustResources": 0,
"discardCards": 0,
"exhaustLeader": false,
}
const { thresholdBonus } = leaderDeployCostView
console.log(thresholdBonus)thresholdBonus:
LeaderDeployThresholdBonus
Defined in: packages/ts-sdk/src/generated/types/common.ts:2785
What counts toward resource_threshold alongside resources.
thresholdTrait?
Example:
import type { LeaderDeployCostView } from '@my-swu/simulator-client'
const leaderDeployCostView: LeaderDeployCostView = {
"resourceThreshold": 0,
"thresholdBonus": "none",
"exhaustResources": 0,
"discardCards": 0,
"exhaustLeader": false,
}
const { thresholdTrait } = leaderDeployCostView
console.log(thresholdTrait)
optionalthresholdTrait?:string|null
Defined in: packages/ts-sdk/src/generated/types/common.ts:2789
Trait counted by FriendlyTraitUnits; None for every other bonus.
