Skip to content
declarative-hex-worlds

ResolvedGameboardLayoutFootprint

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:146

Normalized footprint definition.

Properties

Section titled “Properties”

edges?

Section titled “edges?”

optional edges?: readonly HexEdgeIndex[]

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:152

Neighbor edges used by adjacent footprints.

includeCenter

Section titled “includeCenter”

includeCenter: boolean

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:156

Whether the origin tile is part of the footprint.

kind

Section titled “kind”

kind: "single" | "adjacent" | "radius" | "custom"

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:148

Footprint mode.

offsets?

Section titled “offsets?”

optional offsets?: readonly HexCoordinates[]

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:154

Custom axial offsets included in the footprint.

radius

Section titled “radius”

radius: number

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:150

Radius used by radius footprints.