Pages

src/react

declarative-hex-worlds

src/react

src/react/ — React bindings (first-class, NOT peer-dep gated).

Per the PRD bundled-bindings correction (2026-05-26): react/react-dom are hard dependencies, not optional peers. The library is unusable without its bindings — same shape as koota itself. No runtime guard, no peer-missing branch.

Interfaces

GameboardPlanProviderProps

Defined in: packages/declarative-hex-worlds/src/react/react.ts:288

Props for mounting a serializable plan directly in React.

Properties

children?

optional children?: ReactNode

Defined in: packages/declarative-hex-worlds/src/react/react.ts:292

React children that should read the created runtime and world.

plan

plan: GameboardPlan

Defined in: packages/declarative-hex-worlds/src/react/react.ts:290

Plan to load into a newly created runtime for this provider instance.

GameboardRecipeProviderProps

Defined in: packages/declarative-hex-worlds/src/react/react.ts:298

Props for compiling a recipe and mounting the resulting runtime in React.

Properties

children?

optional children?: ReactNode

Defined in: packages/declarative-hex-worlds/src/react/react.ts:304

React children that should read the created runtime and world.

overrides?

optional overrides?: Partial<GameboardPlanOptions>

Defined in: packages/declarative-hex-worlds/src/react/react.ts:302

Optional plan-generation overrides applied while compiling the recipe.

recipe

recipe: GameboardRecipe

Defined in: packages/declarative-hex-worlds/src/react/react.ts:300

Recipe to compile into a live runtime.

GameboardRuntimeProviderProps

Defined in: packages/declarative-hex-worlds/src/react/react.ts:276

Props for mounting an already-created runtime in React.

Use this when the scene, router, save loader, or test harness owns runtime creation and React should consume the same Koota world plus recipe/scenario helpers.

Type Parameters

TRuntime

TRuntime extends GameboardRuntime = GameboardRuntime

Properties

children?

optional children?: ReactNode

Defined in: packages/declarative-hex-worlds/src/react/react.ts:282

React children that should read the runtime's Koota world.

runtime

runtime: TRuntime

Defined in: packages/declarative-hex-worlds/src/react/react.ts:280

Runtime facade for the board instance mounted below this provider.

GameboardScenarioProviderProps

Defined in: packages/declarative-hex-worlds/src/react/react.ts:310

Props for compiling a scenario and mounting the resulting runtime in React.

Properties

children?

optional children?: ReactNode

Defined in: packages/declarative-hex-worlds/src/react/react.ts:316

React children that should read the created runtime and world.

overrides?

optional overrides?: Partial<GameboardPlanOptions>

Defined in: packages/declarative-hex-worlds/src/react/react.ts:314

Optional recipe overrides applied while compiling the scenario board.

scenario

scenario: GameboardScenario

Defined in: packages/declarative-hex-worlds/src/react/react.ts:312

Scenario containing the board recipe plus actors, patrols, movement, and quests.

Functions

GameboardPlanProvider()

GameboardPlanProvider(__namedParameters): ReactElement<{ }>

Defined in: packages/declarative-hex-worlds/src/react/react.ts:346

Create and mount a runtime from a prebuilt GameboardPlan.

Parameters

__namedParameters

GameboardPlanProviderProps

Returns

ReactElement<{ }>

GameboardProvider()

GameboardProvider(__namedParameters): Element

Defined in: node_modules/.pnpm/koota@0.6.6_@types+react@19.2.17_react@19.2.8/node_modules/koota/dist/react.d.ts:33

Parameters

__namedParameters

children

ReactNode

world

World

Returns

Element

GameboardRecipeProvider()

GameboardRecipeProvider(__namedParameters): ReactElement<{ }>

Defined in: packages/declarative-hex-worlds/src/react/react.ts:357

Compile a recipe, create a runtime, and mount it for React consumers.

Parameters

__namedParameters

GameboardRecipeProviderProps

Returns

ReactElement<{ }>

GameboardRuntimeProvider()

GameboardRuntimeProvider<TRuntime>(__namedParameters): ReactElement<{ }>

Defined in: packages/declarative-hex-worlds/src/react/react.ts:331

Mount a runtime facade and expose its Koota world through koota/react.

This is the preferred provider when runtime creation happens outside React, because useGameboardRuntime returns the same object with scenario/recipe registries, source URL helpers, and live mutation methods intact.

Type Parameters

TRuntime

TRuntime extends GameboardRuntime = GameboardRuntime

Parameters

__namedParameters

GameboardRuntimeProviderProps<TRuntime>

Returns

ReactElement<{ }>

GameboardScenarioProvider()

GameboardScenarioProvider(__namedParameters): ReactElement<{ }>

Defined in: packages/declarative-hex-worlds/src/react/react.ts:375

Compile a scenario, create a runtime, and mount it for React consumers.

The runtime returned by useGameboardRuntime keeps scenario actor/quest indexes, spawn groups, patrol plans, and local source URL helpers available.

Parameters

__namedParameters

GameboardScenarioProviderProps

Returns

ReactElement<{ }>

useAdjacentTileEntities()

useAdjacentTileEntities(entity): readonly Entity[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:992

Read adjacent tile relation targets for one tile entity.

Parameters

entity

Entity | null | undefined

Returns

readonly Entity[]

useCanOccupyGameboardPlacement()

useCanOccupyGameboardPlacement(options): boolean | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1365

Return only the boolean placement-occupancy decision for form controls.

Parameters

options

InspectGameboardPlacementOccupancyOptions | undefined

Returns

boolean | undefined

useDecomposedTileEntities()

useDecomposedTileEntities(): readonly Entity[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:852

Query tile entities with their decomposed coordinate, terrain, and render traits.

Returns

readonly Entity[]

useGameboardActions()

useGameboardActions(): object

Defined in: packages/declarative-hex-worlds/src/react/react.ts:495

Bind low-level board actions for loading, clearing, and spawning tile plans.

Returns

canOccupyPlacement

canOccupyPlacement: (options) => boolean

Return only the boolean occupancy result for a proposed placement.

Parameters

options

InspectGameboardPlacementOccupancyOptions

Returns

boolean

clear

clear: () => void

Remove all board tile, placement, and board-state traits from the world.

Returns

void

inspectPlacementOccupancy

inspectPlacementOccupancy: (options) => GameboardPlacementOccupancyInspection

Inspect whether a proposed placement footprint can occupy its target tiles.

Parameters

options

InspectGameboardPlacementOccupancyOptions

Returns

GameboardPlacementOccupancyInspection

loadPlan

loadPlan: (plan) => GameboardEntityIndex

Replace the current world contents with a complete generated board plan.

Parameters

plan

GameboardPlan

Returns

GameboardEntityIndex

movePlacement

movePlacement: (placement, to, options) => Entity

Move an existing placement to another tile while preserving unspecified state.

Parameters

placement

string | Entity

to

string | HexCoordinates

options?

UpdateGameboardPlacementOptions = {}

Returns

Entity

removePlacement

removePlacement: (placement) => boolean

Remove an existing placement by entity or placement id.

Parameters

placement

string | Entity

Returns

boolean

spawnPlacement

spawnPlacement: (options) => Entity

Spawn a runtime placement into the board.

Parameters

options

SpawnGameboardPlacementOptions

Returns

Entity

updatePlacement

updatePlacement: (placement, options) => Entity

Update an existing runtime placement by entity or placement id.

Parameters

placement

string | Entity

options

UpdateGameboardPlacementOptions

Returns

Entity

useGameboardActor()

useGameboardActor(entity): { actorId: string; blocksMovement: boolean; faction: string | undefined; hostile: boolean; interactive: boolean; kind: GameboardActorKind; metadata: Record<string, GameboardActorMetadataValue>; tags: string[]; team: string | undefined; } | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1026

Read actor metadata for one actor entity.

Parameters

entity

Entity | null | undefined

Returns

Type Literal

{ actorId: string; blocksMovement: boolean; faction: string | undefined; hostile: boolean; interactive: boolean; kind: GameboardActorKind; metadata: Record<string, GameboardActorMetadataValue>; tags: string[]; team: string | undefined; }

actorId

actorId: string = ''

Stable gameplay actor id.

blocksMovement

blocksMovement: boolean = false

Whether this actor blocks movement.

faction

faction: string | undefined

Optional faction identifier.

hostile

hostile: boolean = false

Whether this actor is generally hostile.

interactive

interactive: boolean = false

Whether this actor should be treated as an interaction target.

kind

kind: GameboardActorKind

Actor role used by collision, targeting, commands, and fixtures.

metadata

metadata: Record<string, GameboardActorMetadataValue>

Serializable actor metadata.

team

team: string | undefined

Optional team identifier.

undefined

useGameboardActorActions()

useGameboardActorActions(): object

Defined in: packages/declarative-hex-worlds/src/react/react.ts:511

Bind actor actions for registering, spawning, moving, and updating actors.

Returns

collision

collision: (actor, target, profile) => GameboardActorCollisionReport

Inspect whether an actor can enter a target tile.

Parameters

actor

string | Entity | undefined

command

command: (target, options) => GameboardInteractionCommand

Plan a high-level interaction command from a target input.

Parameters

target

GameboardInteractionTargetInput

options?

GameboardInteractionCommandOptions = {}

Returns

GameboardInteractionCommand

interaction

interaction: (target, options) => GameboardInteractionTargetReport

Resolve and inspect an interaction target.

Parameters

target

GameboardInteractionTargetInput

options?

GameboardInteractionTargetOptions = {}

Returns

GameboardInteractionTargetReport

move

move: (actor, to, options) => Entity

Move an actor to another tile.

Parameters

actor

string | Entity

to

string | HexCoordinates

options?

MoveGameboardActorOptions = {}

Returns

Entity

navigationProfile

navigationProfile: (actor, options) => GameboardNavigationProfile

Create an actor-aware navigation profile.

Parameters

actor

string | Entity

options?

GameboardActorNavigationOptions = {}

Returns

GameboardNavigationProfile

neighborhood

neighborhood: (center, options) => GameboardNeighborhoodInspection

Inspect a radius of tiles around a center.

Parameters

center

GameboardNeighborhoodCenter

options?

GameboardNeighborhoodInspectionOptions = {}

Returns

GameboardNeighborhoodInspection

read

read: () => GameboardActorSnapshot[]

Read all registered actors.

Returns

GameboardActorSnapshot[]

register

register: (placement, options) => Entity

Parameters

placement

string | Entity

options

GameboardActorRegistrationOptions

Returns

Entity

select

select: (options) => GameboardActorSelection

Select actors with optional faction, team, tag, radius, and hostility filters.

Parameters

options?

GameboardActorSelectionOptions = {}

Returns

GameboardActorSelection

spawn

spawn: (options) => Entity

Spawn a placement and register it as an actor.

Parameters

options

SpawnGameboardActorOptions

Returns

Entity

targets

targets: (options) => GameboardActorTargetingReport

Select and path to candidate actor targets.

Parameters

options

GameboardActorTargetingOptions

Returns

GameboardActorTargetingReport

tile

tile: (coordinates, options) => GameboardTileInspection

Inspect one tile from an actor/gameplay perspective.

Parameters

coordinates

string | HexCoordinates

options?

GameboardTileInspectionOptions = {}

Returns

GameboardTileInspection

update

update: (actor, options) => Entity

Update actor trait state while preserving omitted fields.

Parameters

actor

string | Entity

options

UpdateGameboardActorOptions

Returns

Entity

useGameboardActorEntities()

useGameboardActorEntities(): readonly Entity[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:909

Query actor entities together with their origin placement state.

Returns

readonly Entity[]

useGameboardActorSelection()

useGameboardActorSelection(options?): GameboardActorSelection

Defined in: packages/declarative-hex-worlds/src/react/react.ts:800

Select actors by team, hostility, tags, kind, tile, or interaction state.

Parameters

options?

GameboardActorSelectionOptions = {}

Returns

GameboardActorSelection

useGameboardActorsForTile()

useGameboardActorsForTile(coordinates): readonly GameboardActorSnapshot[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:671

Read actor snapshots whose placement origin is one tile.

Use this when hover panels, tile inspectors, collision probes, or ECS mirrors need actor kind, team, hostility, tags, and interaction flags for a single hex without filtering the whole actor list in component code.

Parameters

coordinates

string | HexCoordinates

Returns

readonly GameboardActorSnapshot[]

useGameboardActorSnapshots()

useGameboardActorSnapshots(): readonly GameboardActorSnapshot[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:653

Read joined actor and placement snapshots for React panels and UI state.

The returned records are the same actor snapshots used by runtime reads and external ECS interop, which keeps HUDs, targeting panels, and tests aligned.

Returns

readonly GameboardActorSnapshot[]

useGameboardActorTargetCommand()

useGameboardActorTargetCommand(options): GameboardActorTargetCommandPlan | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:830

Plan the concrete command for one actor-target interaction.

Parameters

options

GameboardActorTargetCommandOptions | undefined

Returns

GameboardActorTargetCommandPlan | undefined

useGameboardActorTargets()

useGameboardActorTargets(options): GameboardActorTargetingReport | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:815

Compute legal interaction targets for one actor from React.

Parameters

options

GameboardActorTargetingOptions | undefined

Returns

GameboardActorTargetingReport | undefined

useGameboardCommandActions()

useGameboardCommandActions(): object

Defined in: packages/declarative-hex-worlds/src/react/react.ts:535

Bind higher-level command actions shared by UI, AI, and test flows.

Returns

execute

execute: (commandOrTarget, options) => GameboardInteractionCommandExecution

Execute a command with optional host-game handlers.

Parameters

commandOrTarget

GameboardInteractionCommandInput

options?

GameboardInteractionCommandExecutionOptions = {}

Returns

GameboardInteractionCommandExecution

plan

plan: (target, options) => GameboardInteractionCommand

Plan a command from a renderer or gameplay target.

Parameters

target

GameboardInteractionTargetInput

options?

GameboardInteractionCommandOptions = {}

Returns

GameboardInteractionCommand

preview

preview: (commandOrTarget, options) => GameboardInteractionCommandPreview

Preview a command without mutating state.

Parameters

commandOrTarget

GameboardInteractionCommandInput

options?

GameboardInteractionCommandPreviewOptions = {}

Returns

GameboardInteractionCommandPreview

targetCommand

targetCommand: (options) => GameboardActorTargetCommandPlan

Select an actor target and plan a command against it.

Parameters

options

GameboardActorTargetCommandOptions

Returns

GameboardActorTargetCommandPlan

useGameboardInteractionCommand()

useGameboardInteractionCommand(target, options?): GameboardInteractionCommand | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:725

Plan the command that would be executed for a selected interaction target.

Parameters

target

GameboardInteractionTargetInput | undefined

options?

GameboardInteractionCommandOptions = {}

Returns

GameboardInteractionCommand | undefined

useGameboardInteractionCommandPreview()

useGameboardInteractionCommandPreview(commandOrTarget, options?): GameboardInteractionCommandPreview | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:745

Preview an interaction command or target for HUD affordances and tests.

Parameters

commandOrTarget

GameboardInteractionCommandInput | undefined

options?

GameboardInteractionCommandPreviewOptions = {}

Returns

GameboardInteractionCommandPreview | undefined

useGameboardInteractionTarget()

useGameboardInteractionTarget(target, options?): GameboardInteractionTargetReport | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:705

Inspect one interaction target from React without dispatching a command.

Parameters

target

GameboardInteractionTargetInput | undefined

options?

GameboardInteractionTargetOptions = {}

Returns

GameboardInteractionTargetReport | undefined

useGameboardLayoutFillAnalysis()

useGameboardLayoutFillAnalysis(options): GameboardLayoutFillAnalysis | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1188

Analyze seeded layout fill rules against the current projected board.

Parameters

options

GameboardLayoutFillOptions | undefined

Returns

GameboardLayoutFillAnalysis | undefined

useGameboardLayoutPlacements()

useGameboardLayoutPlacements(options): readonly SpawnGameboardPlacementOptions[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1202

Preview layout placement options for the current projected board without spawning entities.

Parameters

options

GameboardLayoutPlacementOptions | undefined

Returns

readonly SpawnGameboardPlacementOptions[]

useGameboardLayoutSiteInspection()

useGameboardLayoutSiteInspection(options?): GameboardLayoutSiteInspection | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1175

Inspect layout sites for the current projected board without mutating Koota state.

Parameters

options?

InspectGameboardLayoutSitesOptions = DEFAULT_LAYOUT_SITE_INSPECTION_OPTIONS

Returns

GameboardLayoutSiteInspection | undefined

useGameboardMovementActions()

useGameboardMovementActions(): object

Defined in: packages/declarative-hex-worlds/src/react/react.ts:503

Bind movement actions for starting, advancing, and completing placement paths.

Returns

advance

advance: (placement, options) => GameboardMovementAdvanceResult

Advance one placement along its requested path.

Parameters

placement

string | Entity

options?

AdvanceGameboardMovementOptions = {}

Returns

GameboardMovementAdvanceResult

clear

clear: (placement) => Entity

Clear active movement path state for a placement.

Parameters

placement

string | Entity

Returns

Entity

reachable

reachable: (placement, options) => GameboardReachableTile[]

Return tiles reachable by one movement agent.

Parameters

placement

string | Entity

options?

GameboardMovementOptions = {}

Returns

GameboardReachableTile[]

requestMove

requestMove: (placement, destination, options) => GameboardMovementRequestResult

Request movement to a destination.

Parameters

placement

string | Entity

destination

string | HexCoordinates

options?

GameboardMovementPathRequestOptions = {}

Returns

GameboardMovementRequestResult

resetBudget

resetBudget: (placement?, options) => readonly Entity[]

Reset movement budget for one or all movement agents.

Parameters

placement?

string | Entity

options?

GameboardMovementOptions = {}

Returns

readonly Entity[]

runSystem

runSystem: (options) => GameboardMovementAdvanceResult[]

Advance all active movement agents.

Parameters

options?

AdvanceGameboardMovementOptions = {}

Returns

GameboardMovementAdvanceResult[]

setAgent

setAgent: (placement, options) => Entity

Add or update a movement agent on a placement.

Parameters

placement

string | Entity

options?

SetGameboardMovementAgentOptions = {}

Returns

Entity

useGameboardNavigation()

useGameboardNavigation(profile?): GameboardNavigation | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1122

Build pathfinding helpers from the current projected board.

Parameters

profile?

GameboardNavigationProfile = DEFAULT_NAVIGATION_PROFILE_OPTIONS

Returns

GameboardNavigation | undefined

useGameboardNeighborhoodInspection()

useGameboardNeighborhoodInspection(center, options?): GameboardNeighborhoodInspection

Defined in: packages/declarative-hex-worlds/src/react/react.ts:784

Inspect a tile neighborhood for overlays, local AI decisions, and debug UI.

Parameters

center

GameboardNeighborhoodCenter

options?

GameboardNeighborhoodInspectionOptions = {}

Returns

GameboardNeighborhoodInspection

useGameboardOccupancyIndex()

useGameboardOccupancyIndex(profile?): GameboardOccupancyIndex | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1109

Build a navigation occupancy index from the current projected board.

Parameters

profile?

GameboardNavigationProfile = DEFAULT_NAVIGATION_PROFILE_OPTIONS

Returns

GameboardOccupancyIndex | undefined

useGameboardPatrolActions()

useGameboardPatrolActions(): object

Defined in: packages/declarative-hex-worlds/src/react/react.ts:527

Bind patrol actions for attaching patrol agents and route state.

Returns

advance

advance: (placement, options) => GameboardPatrolAdvanceResult

Advance one patrol agent.

Parameters

placement

string | Entity

options?

AdvanceGameboardPatrolOptions = {}

Returns

GameboardPatrolAdvanceResult

clear

clear: (placement) => Entity

Remove patrol traits from a placement.

Parameters

placement

string | Entity

Returns

Entity

read

read: () => GameboardPatrolSnapshot[]

Read all patrol snapshots.

Returns

GameboardPatrolSnapshot[]

run

run: (options) => GameboardPatrolAdvanceResult[]

Advance every patrol agent in the world.

Parameters

options?

AdvanceGameboardPatrolOptions = {}

Returns

GameboardPatrolAdvanceResult[]

set

set: (placement, options) => Entity

Attach or replace a patrol agent.

Parameters

placement

string | Entity

options

SetGameboardPatrolAgentOptions

Returns

Entity

useGameboardPatrolAgent()

useGameboardPatrolAgent(entity): { active: boolean; currentWaypointIndex: number; loop: boolean; pauseTicks: number; roundsCompleted: number; routeId: string; segmentCosts: number[]; targetWaypointIndex: number; waitTicksRemaining: number; waypointKeys: string[]; } | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1044

Read patrol agent configuration for one actor entity.

Parameters

entity

Entity | null | undefined

Returns

Type Literal

{ active: boolean; currentWaypointIndex: number; loop: boolean; pauseTicks: number; roundsCompleted: number; routeId: string; segmentCosts: number[]; targetWaypointIndex: number; waitTicksRemaining: number; waypointKeys: string[]; }

active

active: boolean = true

Whether the patrol agent is active.

currentWaypointIndex

currentWaypointIndex: number = 0

Current waypoint index.

loop

loop: boolean = true

Whether the route loops back to the first waypoint.

pauseTicks

pauseTicks: number = 0

Ticks to wait after reaching each waypoint.

roundsCompleted

roundsCompleted: number = 0

Number of completed route rounds.

routeId

routeId: string = ''

Route id followed by this patrol.

segmentCosts

segmentCosts: number[]

Optional movement budget per route segment.

targetWaypointIndex

targetWaypointIndex: number = -1

Target waypoint index for an in-flight segment.

waitTicksRemaining

waitTicksRemaining: number = 0

Remaining wait ticks before the next segment.

waypointKeys

waypointKeys: string[]

Ordered route waypoint tile keys.

undefined

useGameboardPatrolAgentEntities()

useGameboardPatrolAgentEntities(): readonly Entity[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:923

Query actors that have patrol agent state attached.

Returns

readonly Entity[]

useGameboardPatrolRoute()

useGameboardPatrolRoute(options): GameboardPatrolRoutePlan | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1148

Plan one patrol route from the current projected board.

Parameters

options

GameboardPatrolRouteOptions | undefined

Returns

GameboardPatrolRoutePlan | undefined

useGameboardPatrolRoutes()

useGameboardPatrolRoutes(options): GameboardPatrolRouteSet | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1161

Plan multiple patrol routes from the current projected board.

Parameters

options

GameboardPatrolRouteSetOptions | undefined

Returns

GameboardPatrolRouteSet | undefined

useGameboardPatrolState()

useGameboardPatrolState(entity): { lastPathKeys: string[]; reason: string | undefined; status: GameboardPatrolStatus; targetKey: string; } | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1053

Read live patrol route progress for one actor entity.

Parameters

entity

Entity | null | undefined

Returns

Type Literal

{ lastPathKeys: string[]; reason: string | undefined; status: GameboardPatrolStatus; targetKey: string; }

lastPathKeys

lastPathKeys: string[]

Last requested movement path tile keys.

reason

reason: string | undefined

Blocked or paused reason.

status

status: GameboardPatrolStatus

Current patrol status.

targetKey

targetKey: string = ''

Current target waypoint tile key.

undefined

useGameboardPieceFillInspection()

useGameboardPieceFillInspection(registry, fills, options?): SeededGameboardPieceFillInspection | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1257

Dry-run selected registry pieces as seeded layout fills for the current projected board.

Parameters

registry

GameboardPieceRegistry | undefined

fills

readonly SeededGameboardPieceFillOptions[] | undefined

options?

InspectSeededGameboardPieceFillsOptions = DEFAULT_PIECE_FILL_INSPECTION_OPTIONS

Returns

SeededGameboardPieceFillInspection | undefined

useGameboardPiecePlacementInspection()

useGameboardPiecePlacementInspection(piece, options?): GameboardPiecePlacementInspection | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1242

Inspect one declared piece against the current projected board.

Parameters

piece

GameboardPieceDeclaration | undefined

options?

GameboardPiecePlacementOptions = DEFAULT_PIECE_PLACEMENT_OPTIONS

Returns

GameboardPiecePlacementInspection | undefined

useGameboardPieceRegistryAnalysis()

useGameboardPieceRegistryAnalysis(registry, options?): GameboardPieceRegistryAnalysis | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1216

Analyze a piece registry for React editor panels and pack setup screens.

Parameters

registry

GameboardPieceRegistry | undefined

options?

AnalyzeGameboardPieceRegistryOptions = DEFAULT_PIECE_REGISTRY_ANALYSIS_OPTIONS

Returns

GameboardPieceRegistryAnalysis | undefined

useGameboardPieceSelection()

useGameboardPieceSelection(registry, selection?): readonly GameboardPieceDeclaration[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1229

Select registered pieces by role, source, tag, asset id, or local-only state.

Parameters

registry

GameboardPieceRegistry | undefined

selection?

GameboardPieceRegistrySelection = DEFAULT_PIECE_REGISTRY_SELECTION

Returns

readonly GameboardPieceDeclaration[]

useGameboardPieceSourceUrlMap()

useGameboardPieceSourceUrlMap(registry, options?): Readonly<Record<string, string>>

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1275

Build renderer URL overrides from registered piece source metadata.

Parameters

registry

GameboardPieceRegistry | undefined

options?

GameboardPieceSourceUrlOptions = DEFAULT_PIECE_SOURCE_URL_OPTIONS

Returns

Readonly<Record<string, string>>

useGameboardPlacementEntities()

useGameboardPlacementEntities(): readonly Entity[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:867

Query all entities that represent board placements on top of tiles.

Returns

readonly Entity[]

useGameboardPlacementOccupancy()

useGameboardPlacementOccupancy(): readonly PlacementOccupancySnapshot[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1331

Read placement occupancy snapshots for every occupied tile.

Returns

readonly PlacementOccupancySnapshot[]

useGameboardPlacementOccupancyInspection()

useGameboardPlacementOccupancyInspection(options): GameboardPlacementOccupancyInspection | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1347

Inspect whether a proposed placement can occupy the current board.

Parameters

options

InspectGameboardPlacementOccupancyOptions | undefined

Returns

GameboardPlacementOccupancyInspection | undefined

useGameboardPlacementSnapshots()

useGameboardPlacementSnapshots(): readonly object[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:636

Read serializable placement snapshots for React panels and external stores.

The hook subscribes to placement trait and relation changes, including in place movement updates where the set of placement entities does not change.

Returns

readonly object[]

useGameboardQuest()

useGameboardQuest(entity): { activeObjectiveIndex: number; metadata: Record<string, GameboardQuestMetadataValue>; objectives: GameboardQuestObjective[]; progress: GameboardQuestObjectiveProgress[]; questId: string; schemaVersion: string; status: GameboardQuestStatus; title: string; } | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1035

Read quest metadata and progress for one quest entity.

Parameters

entity

Entity | null | undefined

Returns

Type Literal

{ activeObjectiveIndex: number; metadata: Record<string, GameboardQuestMetadataValue>; objectives: GameboardQuestObjective[]; progress: GameboardQuestObjectiveProgress[]; questId: string; schemaVersion: string; status: GameboardQuestStatus; title: string; }

activeObjectiveIndex

activeObjectiveIndex: number = 0

Index of the active objective in objectives.

metadata

metadata: Record<string, GameboardQuestMetadataValue>

Serializable quest metadata.

objectives

objectives: GameboardQuestObjective[]

Ordered objective definitions.

progress

progress: GameboardQuestObjectiveProgress[]

Objective progress records.

questId

questId: string = ''

Stable quest id.

schemaVersion

schemaVersion: string = GAMEBOARD_QUEST_SCHEMA_VERSION

Quest schema version.

status

status: GameboardQuestStatus

Runtime quest lifecycle status.

title

title: string = ''

Quest display title.

undefined

useGameboardQuestActions()

useGameboardQuestActions(): object

Defined in: packages/declarative-hex-worlds/src/react/react.ts:519

Bind quest actions for spawning objectives and updating quest progress.

Returns

advance

advance: (quest, options) => GameboardQuestSnapshot

Advance one quest entity.

Parameters

quest

string | Entity

options?

AdvanceGameboardQuestOptions = {}

Returns

GameboardQuestSnapshot

advanceAll

advanceAll: (options) => GameboardQuestSnapshot[]

Advance every quest entity.

Parameters

options?

AdvanceGameboardQuestOptions = {}

Returns

GameboardQuestSnapshot[]

find

find: (quest) => GameboardQuestSnapshot | undefined

Find one quest snapshot.

Parameters

quest

string | Entity

Returns

GameboardQuestSnapshot | undefined

read

read: () => GameboardQuestSnapshot[]

Read all quest snapshots.

Returns

GameboardQuestSnapshot[]

spawn

spawn: (definition, options) => Entity

Spawn a quest entity.

Parameters

definition

GameboardQuestDefinition

options?

SpawnGameboardQuestOptions = {}

Returns

Entity

useGameboardQuestEntities()

useGameboardQuestEntities(): readonly Entity[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:916

Query all quest entities in the current board world.

Returns

readonly Entity[]

useGameboardQuestSnapshots()

useGameboardQuestSnapshots(): readonly GameboardQuestSnapshot[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:691

Read quest snapshots for React quest logs, HUDs, and integration mirrors.

The hook rerenders when quest state changes or when related actor movement changes may complete reach, interaction, collision, or defeat objectives.

Returns

readonly GameboardQuestSnapshot[]

useGameboardRuleViolations()

useGameboardRuleViolations(config?): readonly GameboardRuleViolation[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1389

Validate the live Koota world against gameboard rule configuration.

Parameters

config?

GameboardRuleConfig = DEFAULT_RULE_CONFIG

Returns

readonly GameboardRuleViolation[]

useGameboardRuntime()

useGameboardRuntime<TRuntime>(): TRuntime

Defined in: packages/declarative-hex-worlds/src/react/react.ts:556

Return the runtime facade associated with the current React provider.

If no runtime provider was mounted, the hook binds a facade to the current Koota world. Use GameboardRuntimeProvider or the plan/recipe/scenario providers when components need runtime-specific helpers such as source URL maps, scenario indexes, or saved recipe registries.

Type Parameters

TRuntime

TRuntime extends GameboardRuntime = GameboardRuntime

Returns

TRuntime

useGameboardRuntimeSnapshot()

useGameboardRuntimeSnapshot(options?): GameboardRuntimeSnapshot

Defined in: packages/declarative-hex-worlds/src/react/react.ts:618

Read the current runtime snapshot and rerender when gameboard traits, relations, actor state, movement state, patrol state, or quest state changes.

This is the React equivalent of runtime.snapshot(). Use it for HUDs, inspectors, test probes, and render adapters that want a serializable view of live board state instead of raw Koota trait access.

Parameters

options?

GameboardRuntimeSnapshotOptions = DEFAULT_RUNTIME_SNAPSHOT_OPTIONS

Returns

GameboardRuntimeSnapshot

useGameboardSpawnLocations()

useGameboardSpawnLocations(options): readonly SpawnLocation[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1135

Select legal spawn locations from the current projected board.

Parameters

options

GameboardSpawnLocationOptions | undefined

Returns

readonly SpawnLocation[]

useGameboardState()

useGameboardState(): { placementCount: number; schemaVersion: string; seed: string; shape: GameboardShape; textureSet: "default" | "fall" | "summer" | "winter"; tileCount: number; } | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:488

Read the root board state trait from the current Koota world.

Returns

Type Literal

{ placementCount: number; schemaVersion: string; seed: string; shape: GameboardShape; textureSet: "default" | "fall" | "summer" | "winter"; tileCount: number; }

placementCount

placementCount: number = 0

Number of placement entities loaded into the world.

schemaVersion

schemaVersion: string = GAMEBOARD_SCHEMA_VERSION

Manifest/schema version used to generate the loaded board.

seed

seed: string = ''

Seed used by deterministic layout or simulation helpers.

shape

shape: GameboardShape

Board shape descriptor, such as rectangle or hexagon.

textureSet

textureSet: "default" | "fall" | "summer" | "winter"

Active KayKit texture set for generated terrain and placements.

tileCount

tileCount: number = 0

Number of tile entities loaded into the world.

undefined

useGameboardSystemActions()

useGameboardSystemActions(): object

Defined in: packages/declarative-hex-worlds/src/react/react.ts:543

Bind system tick actions for running movement, patrol, and quest systems.

Returns

dispatchActorTargetCommand

dispatchActorTargetCommand: (options, commandOptions) => DispatchGameboardActorTargetCommandResult

Select an actor target, then execute its planned command.

Parameters

options

GameboardActorTargetCommandOptions

commandOptions?

DispatchGameboardInteractionCommandOptions = {}

Returns

DispatchGameboardActorTargetCommandResult

dispatchCommand

dispatchCommand: (commandOrTarget, options) => DispatchGameboardInteractionCommandResult

Execute one command and emit dispatch event records.

Parameters

commandOrTarget

GameboardInteractionCommandInput

options?

DispatchGameboardInteractionCommandOptions = {}

Returns

DispatchGameboardInteractionCommandResult

interact

interact: (commandOrTarget, options) => RunGameboardInteractionResult

Dispatch a command and optionally tick systems.

Parameters

commandOrTarget

GameboardInteractionCommandInput

options?

RunGameboardInteractionOptions = {}

Returns

RunGameboardInteractionResult

interactActorTarget

interactActorTarget: (options, interactionOptions) => RunGameboardActorTargetInteractionResult

Target an actor, dispatch the command, and optionally tick systems.

Parameters

options

GameboardActorTargetCommandOptions

interactionOptions?

RunGameboardInteractionOptions = {}

Returns

RunGameboardActorTargetInteractionResult

run

run: (options) => RunGameboardSystemsResult

Run enabled patrol, movement, and quest systems for one tick.

Parameters

options?

RunGameboardSystemsOptions = {}

Returns

RunGameboardSystemsResult

useGameboardTileEntities()

useGameboardTileEntities(): readonly Entity[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:845

Query all entities that represent canonical gameboard tiles.

Returns

readonly Entity[]

useGameboardTileInspection()

useGameboardTileInspection(coordinates, options?): GameboardTileInspection

Defined in: packages/declarative-hex-worlds/src/react/react.ts:767

Inspect terrain, connectivity, occupancy, and actor state for one tile.

Parameters

coordinates

string | HexCoordinates

options?

GameboardTileInspectionOptions = {}

Returns

GameboardTileInspection

useGameboardWorld()

useGameboardWorld(): World

Defined in: node_modules/.pnpm/koota@0.6.6_@types+react@19.2.17_react@19.2.8/node_modules/koota/dist/react.d.ts:31

Returns

World

useHarborPlacementEntities()

useHarborPlacementEntities(): readonly Entity[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:888

Query placement entities tagged as harbors or ports.

Returns

readonly Entity[]

useMovementAgent()

useMovementAgent(entity): { movementBudget: number; profileId: GameboardMovementProfileId; remainingMovement: number; } | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1008

Read movement agent metadata for one moving placement.

Parameters

entity

Entity | null | undefined

Returns

Type Literal

{ movementBudget: number; profileId: GameboardMovementProfileId; remainingMovement: number; }

movementBudget

movementBudget: number = 6

Maximum movement budget.

profileId

profileId: GameboardMovementProfileId

Movement profile id used by this agent.

remainingMovement

remainingMovement: number = 6

Remaining movement budget in the current cycle.

undefined

useMovementPathState()

useMovementPathState(entity): { cost: number; destinationKey: string; nextIndex: number; pathKeys: string[]; reason: string | undefined; spentCost: number; status: GameboardMovementStatus; visited: number; } | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1017

Read current path-following state for one moving placement.

Parameters

entity

Entity | null | undefined

Returns

Type Literal

{ cost: number; destinationKey: string; nextIndex: number; pathKeys: string[]; reason: string | undefined; spentCost: number; status: GameboardMovementStatus; visited: number; }

cost

cost: number = 0

Total planned path cost.

destinationKey

destinationKey: string = ''

Destination tile key for the current request.

nextIndex

nextIndex: number = 0

Next path index to advance to.

pathKeys

pathKeys: string[]

Planned path tile keys.

reason

reason: string | undefined

Blocked or out-of-range reason.

spentCost

spentCost: number = 0

Cost spent so far.

status

status: GameboardMovementStatus

Current movement status.

visited

visited: number = 0

Number of pathfinder nodes visited for the request.

undefined

useMovingPlacementEntities()

useMovingPlacementEntities(): readonly Entity[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:902

Query placements currently controlled by movement state.

Returns

readonly Entity[]

useOriginPlacementEntitiesForTile()

useOriginPlacementEntitiesForTile(coordinates): readonly Entity[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1374

Read placements whose origin tile is exactly the requested tile.

Parameters

coordinates

string | HexCoordinates

Returns

readonly Entity[]

usePlacementEntitiesForTile()

usePlacementEntitiesForTile(coordinates): readonly Entity[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1297

Read every placement that occupies one tile, including multi-tile footprints.

Parameters

coordinates

string | HexCoordinates

Returns

readonly Entity[]

usePlacementOccupancyForTile()

usePlacementOccupancyForTile(coordinates): readonly PlacementOccupancySnapshot[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1312

Read placement occupancy snapshots for one tile key or coordinate.

Parameters

coordinates

string | HexCoordinates

Returns

readonly PlacementOccupancySnapshot[]

usePlacementsByClassifier()

usePlacementsByClassifier(tag): readonly GameboardPlacementSpec[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1097

Live placements carrying a gameplay classifier tag (RFC0-TAG). Reactively filters the projected plan's placements by classifier metadata — re-runs when the board changes. e.g. usePlacementsByClassifier('enemy') drives an enemy overlay.

Parameters

tag

ClassifierTag

Returns

readonly GameboardPlacementSpec[]

usePlacementState()

usePlacementState(entity): { assetId: string; coordinates: HexCoordinates; elevation: number; elevationOffset: number; id: string; kind: GameboardPlacementKind; layer: GameboardPlacementLayer; metadata: Record<string, string | number | boolean | null>; order: number; position: WorldPosition; requiresExtra: boolean; rotationRadians: number; rotationSteps: number; scale: number; stackIndex: number | undefined; textureSet: "default" | "fall" | "summer" | "winter"; tileKey: string; } | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:999

Read placement state for one placement or actor entity.

Parameters

entity

Entity | null | undefined

Returns

Type Literal

{ assetId: string; coordinates: HexCoordinates; elevation: number; elevationOffset: number; id: string; kind: GameboardPlacementKind; layer: GameboardPlacementLayer; metadata: Record<string, string | number | boolean | null>; order: number; position: WorldPosition; requiresExtra: boolean; rotationRadians: number; rotationSteps: number; scale: number; stackIndex: number | undefined; textureSet: "default" | "fall" | "summer" | "winter"; tileKey: string; }

assetId

assetId: string = ''

Manifest or external registry asset id.

coordinates

coordinates: HexCoordinates

Axial coordinates of the origin tile.

elevation

elevation: number = 0

Base tile elevation where the placement was spawned.

elevationOffset

elevationOffset: number = 0

Extra vertical offset above the tile elevation.

id

id: string = ''

Stable placement id.

kind

kind: GameboardPlacementKind

Gameplay category for rules, selectors, and rendering.

layer

layer: GameboardPlacementLayer

Render and occupancy layer.

metadata

metadata: Record<string, string | number | boolean | null>

Serializable placement metadata for rules, ECS interop, and render hints.

order

order: number = 0

Stable sort order used by renderers and snapshots.

position

position: WorldPosition

World-space placement anchor after elevation and local offsets.

requiresExtra

requiresExtra: boolean = false

Whether the placement depends on local-only EXTRA assets.

rotationRadians

rotationRadians: number = 0

Rotation in radians derived from rotationSteps.

rotationSteps

rotationSteps: number = 0

Clockwise 60-degree rotation steps.

scale

scale: number = 1

Uniform render scale.

stackIndex

stackIndex: number | undefined

Optional stack index for layered terrain and vertical props.

textureSet

textureSet: "default" | "fall" | "summer" | "winter"

KayKit texture set applied to this placement.

tileKey

tileKey: string = ''

Origin tile key in q,r form.

undefined

useProjectedGameboardPlan()

useProjectedGameboardPlan(options?): GameboardPlan | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1062

Project the live Koota world back into a serializable GameboardPlan.

Parameters

options?

ProjectWorldOptions

Returns

GameboardPlan | undefined

useRiverPlacementEntities()

useRiverPlacementEntities(): readonly Entity[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:881

Query placement entities tagged as rivers.

Returns

readonly Entity[]

useRoadPlacementEntities()

useRoadPlacementEntities(): readonly Entity[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:874

Query placement entities tagged as roads.

Returns

readonly Entity[]

useStackedTerrainEntities()

useStackedTerrainEntities(): readonly Entity[]

Defined in: packages/declarative-hex-worlds/src/react/react.ts:895

Query terrain placements that participate in vertical stacking.

Returns

readonly Entity[]

useTileConnectivity()

useTileConnectivity(entity): { coastEdges: number; coastWaterless: boolean; riverCrossing: "A" | "B" | undefined; riverCurvy: boolean; riverEdges: number; riverWaterless: boolean; roadEdges: number; roadSlope: "high" | "low" | undefined; } | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:967

Read six-edge connectivity data for one tile entity.

Parameters

entity

Entity | null | undefined

Returns

Type Literal

{ coastEdges: number; coastWaterless: boolean; riverCrossing: "A" | "B" | undefined; riverCurvy: boolean; riverEdges: number; riverWaterless: boolean; roadEdges: number; roadSlope: "high" | "low" | undefined; }

coastEdges

coastEdges: number = 0

Six-edge bitmask for coast connectivity.

coastWaterless

coastWaterless: boolean = false

Whether this coast tile uses the waterless guide variant.

riverCrossing

riverCrossing: "A" | "B" | undefined

River crossing variant, when present.

riverCurvy

riverCurvy: boolean = false

Whether this river tile uses the curvy guide variant.

riverEdges

riverEdges: number = 0

Six-edge bitmask for river connectivity.

riverWaterless

riverWaterless: boolean = false

Whether this river tile uses the waterless guide variant.

roadEdges

roadEdges: number = 0

Six-edge bitmask for road connectivity.

roadSlope

roadSlope: "high" | "low" | undefined

Road slope variant when a road changes elevation.

undefined

useTileCoordinates()

useTileCoordinates(entity): { key: string; q: number; r: number; } | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:942

Read axial coordinates for one tile entity.

Parameters

entity

Entity | null | undefined

Returns

Type Literal

{ key: string; q: number; r: number; }

key

key: string = ''

Stable axial key in q,r form.

q

q: number = 0

Axial q coordinate.

r

r: number = 0

Axial r coordinate.

undefined

useTileElevation()

useTileElevation(entity): { baseAssetId: string; elevation: number; supportAssetId: string; } | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:958

Read base elevation data for one tile entity.

Parameters

entity

Entity | null | undefined

Returns

Type Literal

{ baseAssetId: string; elevation: number; supportAssetId: string; }

baseAssetId

baseAssetId: string = ''

Asset id for the visible tile top.

elevation

elevation: number = 0

Stacked elevation level for the tile top.

supportAssetId

supportAssetId: string = ''

Optional asset id for the vertical support below elevated tiles.

undefined

useTileEntity()

useTileEntity(coordinates): Entity | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:1288

Find the tile entity for one axial coordinate or tile key.

Parameters

coordinates

string | HexCoordinates

Returns

Entity | undefined

useTileRenderState()

useTileRenderState(entity): { textureSet: "default" | "fall" | "summer" | "winter"; } | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:976

Read render placement data for one tile entity.

Parameters

entity

Entity | null | undefined

Returns

Type Literal

{ textureSet: "default" | "fall" | "summer" | "winter"; }

textureSet

textureSet: "default" | "fall" | "summer" | "winter"

KayKit texture set applied to this tile.

undefined

useTileState()

useTileState(entity): { baseAssetId: string; coastEdges: number; coastWaterless: boolean; coordinates: HexCoordinates; elevation: number; key: string; riverCrossing: "A" | "B" | undefined; riverCurvy: boolean; riverEdges: number; riverWaterless: boolean; roadEdges: number; roadSlope: "high" | "low" | undefined; supportAssetId: string; tags: string[]; terrain: GameboardTerrain; textureSet: "default" | "fall" | "summer" | "winter"; } | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:935

Read the canonical tile trait for one tile entity.

Parameters

entity

Entity | null | undefined

Returns

Type Literal

{ baseAssetId: string; coastEdges: number; coastWaterless: boolean; coordinates: HexCoordinates; elevation: number; key: string; riverCrossing: "A" | "B" | undefined; riverCurvy: boolean; riverEdges: number; riverWaterless: boolean; roadEdges: number; roadSlope: "high" | "low" | undefined; supportAssetId: string; tags: string[]; terrain: GameboardTerrain; textureSet: "default" | "fall" | "summer" | "winter"; }

baseAssetId

baseAssetId: string = ''

Asset id for the visible tile top.

coastEdges

coastEdges: number = 0

Six-edge bitmask for coast connectivity.

coastWaterless

coastWaterless: boolean = false

Whether this coast tile uses the waterless guide variant.

coordinates

coordinates: HexCoordinates

Axial tile coordinates.

elevation

elevation: number = 0

Stacked elevation level for the tile top.

key

key: string = ''

Stable axial key in q,r form.

riverCrossing

riverCrossing: "A" | "B" | undefined

River crossing variant, when present.

riverCurvy

riverCurvy: boolean = false

Whether this river tile uses the curvy guide variant.

riverEdges

riverEdges: number = 0

Six-edge bitmask for river connectivity.

riverWaterless

riverWaterless: boolean = false

Whether this river tile uses the waterless guide variant.

roadEdges

roadEdges: number = 0

Six-edge bitmask for road connectivity.

roadSlope

roadSlope: "high" | "low" | undefined

Road slope variant when a road changes elevation.

supportAssetId

supportAssetId: string = ''

Optional asset id for the vertical support below elevated tiles.

terrain

terrain: GameboardTerrain

Primary terrain biome represented by this tile.

textureSet

textureSet: "default" | "fall" | "summer" | "winter"

KayKit texture set applied to this tile.

undefined

useTileTagList()

useTileTagList(entity): string[] | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:985

Read normalized tags attached to one tile entity.

Parameters

entity

Entity | null | undefined

Returns

string[] | undefined

useTileTerrain()

useTileTerrain(entity): { terrain: GameboardTerrain; } | undefined

Defined in: packages/declarative-hex-worlds/src/react/react.ts:951

Read terrain classification for one tile entity.

Parameters

entity

Entity | null | undefined

Returns

Type Literal

{ terrain: GameboardTerrain; }

terrain

terrain: GameboardTerrain

Primary terrain biome represented by this tile.

undefined

Built with

Edit this page MIT License KayKit assets