Skip to content
declarative-hex-worlds

OverlayControls

Defined in: packages/declarative-hex-worlds/src/overlay/overlay.ts:27

Dev-controllable overlay controls layered on top of the normalization.

Properties

Section titled “Properties”

anchor?

Section titled “anchor?”

readonly optional anchor?: OverlayAnchor

Defined in: packages/declarative-hex-worlds/src/overlay/overlay.ts:29

Anchor within the cell (default center 0.5,0.5).

cell?

Section titled “cell?”

readonly optional cell?: object

Defined in: packages/declarative-hex-worlds/src/overlay/overlay.ts:37

The cell the anchor is measured against (default KayKit hex).

depth?

Section titled “depth?”

readonly optional depth?: number

width?

Section titled “width?”

readonly optional width?: number

offset?

Section titled “offset?”

readonly optional offset?: Partial<WorldPosition>

Defined in: packages/declarative-hex-worlds/src/overlay/overlay.ts:31

Additional world-space nudge applied after anchoring.

rotationY?

Section titled “rotationY?”

readonly optional rotationY?: number

Defined in: packages/declarative-hex-worlds/src/overlay/overlay.ts:33

Additional Y rotation (radians) on top of the placement rotation.

scale?

Section titled “scale?”

readonly optional scale?: number

Defined in: packages/declarative-hex-worlds/src/overlay/overlay.ts:35

Multiplier on the normalized scale (1 = normalized size).