AddUnitRecipeStep
Defined in: packages/declarative-hex-worlds/src/scenario/recipe.ts:338
Recipe step that places a single unit asset.
Extends
Section titled “Extends”Properties
Section titled “Properties”action
Section titled “action”action:
"addUnit"
Defined in: packages/declarative-hex-worlds/src/scenario/recipe.ts:340
Discriminator for unit placement.
at:
HexCoordinates
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:614
Tile where the unit part is anchored.
Inherited from
Section titled “Inherited from”compositeId?
Section titled “compositeId?”
optionalcompositeId?:string
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:624
Shared composite id for multi-part units.
Inherited from
Section titled “Inherited from”UnitPlacementOptions.compositeId
faction?
Section titled “faction?”
optionalfaction?:"blue"|"green"|"red"|"yellow"
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:618
Faction used by colored unit parts.
Inherited from
Section titled “Inherited from”neutral?
Section titled “neutral?”
optionalneutral?:boolean
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:622
Force neutral unit asset selection.
Inherited from
Section titled “Inherited from”part:
"banner"|"bow"|"cannon"|"cart"|"cart_merchant"|"catapult"|"helmet"|"horse"|"projectile_arrow"|"shield"|"ship"|"spear"|"sword"|"unit"|"hammer"|"horse_A"|"horse_B"|"horse_C"|"horse_D"|"horse_E"|"horse_F"|"horse_G"|"horse_saddle"|"projectile_cannonball"|"projectile_catapult"|"shovel"
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:616
Unit part asset id.
Inherited from
Section titled “Inherited from”rotationSteps?
Section titled “rotationSteps?”
optionalrotationSteps?:number
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:626
Clockwise 60-degree rotation steps.
Inherited from
Section titled “Inherited from”UnitPlacementOptions.rotationSteps
scale?
Section titled “scale?”
optionalscale?:number
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:628
Uniform render scale.
Inherited from
Section titled “Inherited from”style?
Section titled “style?”
optionalstyle?:"accent"|"full"
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:620
Colored unit style.