AddElevationRampRecipeStep
Defined in: packages/declarative-hex-worlds/src/scenario/recipe.ts:268
Recipe step that places a sloped elevation ramp with ramp-specific metadata.
Extends
Section titled “Extends”Properties
Section titled “Properties”action
Section titled “action”action:
"addElevationRamp"
Defined in: packages/declarative-hex-worlds/src/scenario/recipe.ts:270
Discriminator for elevation ramp placement.
at:
HexCoordinates
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:470
Lower tile where the visible ramp is anchored.
Inherited from
Section titled “Inherited from”direction?
Section titled “direction?”
optionaldirection?:ElevationRampDirection
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:472
Visual ramp direction. Defaults to up.
Inherited from
Section titled “Inherited from”ElevationRampOptions.direction
elevationOffset?
Section titled “elevationOffset?”
optionalelevationOffset?:number
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:484
Fractional elevation offset above the tile surface.
Inherited from
Section titled “Inherited from”ElevationRampOptions.elevationOffset
facing?
Section titled “facing?”
optionalfacing?:HexEdgeIndex
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:474
Edge the ramp points toward; also used as the default rotation.
Inherited from
Section titled “Inherited from”fromElevation?
Section titled “fromElevation?”
optionalfromElevation?:number
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:478
Elevation on the anchor tile. Defaults to the tile elevation.
Inherited from
Section titled “Inherited from”ElevationRampOptions.fromElevation
rotationSteps?
Section titled “rotationSteps?”
optionalrotationSteps?:number
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:476
Clockwise 60-degree rotation steps. Overrides facing when provided.
Inherited from
Section titled “Inherited from”ElevationRampOptions.rotationSteps
scale?
Section titled “scale?”
optionalscale?:number
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:486
Uniform render scale.
Inherited from
Section titled “Inherited from”textureSet?
Section titled “textureSet?”
optionaltextureSet?:"default"|"fall"|"summer"|"winter"
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:482
Texture set to apply to the anchor tile before placing the ramp.
Inherited from
Section titled “Inherited from”ElevationRampOptions.textureSet
toElevation?
Section titled “toElevation?”
optionaltoElevation?:number
Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:480
Elevation reached by the ramp. Defaults to one level above or below fromElevation.