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: src/react/react.ts:865
Read six-edge connectivity data for one tile entity.
Parameters
Section titled “Parameters”entity
Section titled “entity”Entity | null | undefined
Returns
Section titled “Returns”Type Literal
Section titled “Type Literal”{ coastEdges: number; coastWaterless: boolean; riverCrossing: "A" | "B" | undefined; riverCurvy: boolean; riverEdges: number; riverWaterless: boolean; roadEdges: number; roadSlope: "high" | "low" | undefined; }
coastEdges
Section titled “coastEdges”coastEdges:
number=0
Six-edge bitmask for coast connectivity.
coastWaterless
Section titled “coastWaterless”coastWaterless:
boolean=false
Whether this coast tile uses the waterless guide variant.
riverCrossing
Section titled “riverCrossing”riverCrossing:
"A"|"B"|undefined
River crossing variant, when present.
riverCurvy
Section titled “riverCurvy”riverCurvy:
boolean=false
Whether this river tile uses the curvy guide variant.
riverEdges
Section titled “riverEdges”riverEdges:
number=0
Six-edge bitmask for river connectivity.
riverWaterless
Section titled “riverWaterless”riverWaterless:
boolean=false
Whether this river tile uses the waterless guide variant.
roadEdges
Section titled “roadEdges”roadEdges:
number=0
Six-edge bitmask for road connectivity.
roadSlope
Section titled “roadSlope”roadSlope:
"high"|"low"|undefined
Road slope variant when a road changes elevation.
undefined