GameboardNeighborhoodTileInspection
Defined in: src/actors/actors.ts:344
Tile inspection with distance from the inspected neighborhood center.
Extends
Section titled “Extends”Properties
Section titled “Properties”actors
Section titled “actors”actors: readonly
GameboardActorSnapshot[]
Defined in: src/actors/actors.ts:280
Actor placements on the tile.
Inherited from
Section titled “Inherited from”GameboardTileInspection.actors
blockingPlacements
Section titled “blockingPlacements”blockingPlacements: readonly
object[]
Defined in: src/actors/actors.ts:288
Placements that block movement onto the tile.
Inherited from
Section titled “Inherited from”GameboardTileInspection.blockingPlacements
canEnter
Section titled “canEnter”canEnter:
boolean
Defined in: src/actors/actors.ts:292
Whether the tile exists and can be entered.
Inherited from
Section titled “Inherited from”GameboardTileInspection.canEnter
collision
Section titled “collision”collision:
GameboardActorCollisionReport
Defined in: src/actors/actors.ts:290
Full collision report for the tile.
Inherited from
Section titled “Inherited from”GameboardTileInspection.collision
coordinates?
Section titled “coordinates?”
optionalcoordinates?:HexCoordinates
Defined in: src/actors/actors.ts:268
Axial coordinates, when the tile exists.
Inherited from
Section titled “Inherited from”GameboardTileInspection.coordinates
distance
Section titled “distance”distance:
number
Defined in: src/actors/actors.ts:346
Hex distance from the neighborhood center.
elevation?
Section titled “elevation?”
optionalelevation?:number
Defined in: src/actors/actors.ts:272
Tile elevation, when the tile exists.
Inherited from
Section titled “Inherited from”GameboardTileInspection.elevation
exists
Section titled “exists”exists:
boolean
Defined in: src/actors/actors.ts:262
Whether the tile exists in the board.
Inherited from
Section titled “Inherited from”GameboardTileInspection.exists
hasActors
Section titled “hasActors”hasActors:
boolean
Defined in: src/actors/actors.ts:296
Whether any actors occupy the tile.
Inherited from
Section titled “Inherited from”GameboardTileInspection.hasActors
hasHostiles
Section titled “hasHostiles”hasHostiles:
boolean
Defined in: src/actors/actors.ts:298
Whether any hostile actors occupy the tile.
Inherited from
Section titled “Inherited from”GameboardTileInspection.hasHostiles
hasInteractive
Section titled “hasInteractive”hasInteractive:
boolean
Defined in: src/actors/actors.ts:300
Whether any interactive actors occupy the tile.
Inherited from
Section titled “Inherited from”GameboardTileInspection.hasInteractive
hasProps
Section titled “hasProps”hasProps:
boolean
Defined in: src/actors/actors.ts:302
Whether any prop actors occupy the tile.
Inherited from
Section titled “Inherited from”GameboardTileInspection.hasProps
hostileActors
Section titled “hostileActors”hostileActors: readonly
GameboardActorSnapshot[]
Defined in: src/actors/actors.ts:282
Hostile actors on the tile.
Inherited from
Section titled “Inherited from”GameboardTileInspection.hostileActors
interactiveActors
Section titled “interactiveActors”interactiveActors: readonly
GameboardActorSnapshot[]
Defined in: src/actors/actors.ts:284
Interactive actors on the tile.
Inherited from
Section titled “Inherited from”GameboardTileInspection.interactiveActors
isEmpty
Section titled “isEmpty”isEmpty:
boolean
Defined in: src/actors/actors.ts:294
Whether no placements occupy the tile.
Inherited from
Section titled “Inherited from”GameboardTileInspection.isEmpty
occupancy
Section titled “occupancy”occupancy: readonly
PlacementOccupancySnapshot[]
Defined in: src/actors/actors.ts:278
Occupancy relation records for the tile.
Inherited from
Section titled “Inherited from”GameboardTileInspection.occupancy
placements
Section titled “placements”placements: readonly
object[]
Defined in: src/actors/actors.ts:276
Placements occupying the tile.
Inherited from
Section titled “Inherited from”GameboardTileInspection.placements
propActors
Section titled “propActors”propActors: readonly
GameboardActorSnapshot[]
Defined in: src/actors/actors.ts:286
Prop actors on the tile.
Inherited from
Section titled “Inherited from”GameboardTileInspection.propActors
reason?
Section titled “reason?”
optionalreason?:string
Defined in: src/actors/actors.ts:304
Missing or blocked reason.
Inherited from
Section titled “Inherited from”GameboardTileInspection.reason
tags: readonly
string[]
Defined in: src/actors/actors.ts:274
Tile tags, or an empty list for missing tiles.
Inherited from
Section titled “Inherited from”terrain?
Section titled “terrain?”
optionalterrain?:GameboardTerrain
Defined in: src/actors/actors.ts:270
Tile terrain, when the tile exists.
Inherited from
Section titled “Inherited from”GameboardTileInspection.terrain
optionaltile?:object
Defined in: src/actors/actors.ts:266
Tile trait value, when the tile exists.
baseAssetId
Section titled “baseAssetId”baseAssetId:
string=''
Asset id for the visible tile top.
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.
coordinates
Section titled “coordinates”coordinates:
HexCoordinates
Axial tile coordinates.
elevation
Section titled “elevation”elevation:
number=0
Stacked elevation level for the tile top.
key:
string=''
Stable axial key in q,r form.
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.
supportAssetId
Section titled “supportAssetId”supportAssetId:
string=''
Optional asset id for the vertical support below elevated tiles.
tags:
string[]
Free-form taxonomy and generation tags.
terrain
Section titled “terrain”terrain:
GameboardTerrain
Primary terrain biome represented by this tile.
textureSet
Section titled “textureSet”textureSet:
"default"|"fall"|"summer"|"winter"
KayKit texture set applied to this tile.
Inherited from
Section titled “Inherited from”tileKey
Section titled “tileKey”tileKey:
string
Defined in: src/actors/actors.ts:264
Inspected tile key.