Skip to content
declarative-hex-worlds

GameboardNeighborhoodInspectionOptions

Defined in: src/actors/actors.ts:315

Filters and options for actor-aware neighborhood inspection.

Extends

Section titled “Extends”

Properties

Section titled “Properties”

blockingPlacementKinds?

Section titled “blockingPlacementKinds?”

optional blockingPlacementKinds?: readonly GameboardPlacementKind[]

Defined in: src/actors/actors.ts:132

Placement kinds that should block actor movement.

Inherited from

Section titled “Inherited from”

GameboardTileInspectionOptions.blockingPlacementKinds

blockingPlacementLayers?

Section titled “blockingPlacementLayers?”

optional blockingPlacementLayers?: readonly GameboardPlacementLayer[]

Defined in: src/actors/actors.ts:134

Placement layers that should block actor movement.

Inherited from

Section titled “Inherited from”

GameboardTileInspectionOptions.blockingPlacementLayers

canEnter?

Section titled “canEnter?”

optional canEnter?: boolean

Defined in: src/actors/actors.ts:330

Filter by enterable state.

excludeTileTags?

Section titled “excludeTileTags?”

optional excludeTileTags?: readonly string[]

Defined in: src/actors/actors.ts:328

Tile tags that must be absent.

hasActors?

Section titled “hasActors?”

optional hasActors?: boolean

Defined in: src/actors/actors.ts:332

Filter by actor presence.

hasHostiles?

Section titled “hasHostiles?”

optional hasHostiles?: boolean

Defined in: src/actors/actors.ts:334

Filter by hostile actor presence.

hasInteractive?

Section titled “hasInteractive?”

optional hasInteractive?: boolean

Defined in: src/actors/actors.ts:336

Filter by interactive actor presence.

hasProps?

Section titled “hasProps?”

optional hasProps?: boolean

Defined in: src/actors/actors.ts:338

Filter by prop actor presence.

ignorePlacementIds?

Section titled “ignorePlacementIds?”

optional ignorePlacementIds?: readonly string[]

Defined in: src/actors/actors.ts:136

Placement ids ignored during collision checks.

Inherited from

Section titled “Inherited from”

GameboardTileInspectionOptions.ignorePlacementIds

includeCenter?

Section titled “includeCenter?”

optional includeCenter?: boolean

Defined in: src/actors/actors.ts:320

Include the center tile in results. Defaults to true.

includeMissing?

Section titled “includeMissing?”

optional includeMissing?: boolean

Defined in: src/actors/actors.ts:322

Include missing tiles in results. Defaults to false.

radius?

Section titled “radius?”

optional radius?: number

Defined in: src/actors/actors.ts:318

Hex radius around the center. Defaults to 1.

sourceActor?

Section titled “sourceActor?”

optional sourceActor?: string | Entity

Defined in: src/actors/actors.ts:254

Source actor used for collision interpretation.

Inherited from

Section titled “Inherited from”

GameboardTileInspectionOptions.sourceActor

terrain?

Section titled “terrain?”

optional terrain?: GameboardTerrain | readonly GameboardTerrain[]

Defined in: src/actors/actors.ts:324

Required terrain or accepted terrains.

tileTags?

Section titled “tileTags?”

optional tileTags?: readonly string[]

Defined in: src/actors/actors.ts:326

Required tile tags.

treatHostileAsBlocking?

Section titled “treatHostileAsBlocking?”

optional treatHostileAsBlocking?: boolean

Defined in: src/actors/actors.ts:138

Treat hostile actors as movement blockers.

Inherited from

Section titled “Inherited from”

GameboardTileInspectionOptions.treatHostileAsBlocking

treatInteractiveAsBlocking?

Section titled “treatInteractiveAsBlocking?”

optional treatInteractiveAsBlocking?: boolean

Defined in: src/actors/actors.ts:140

Treat interactive actors as movement blockers.

Inherited from

Section titled “Inherited from”

GameboardTileInspectionOptions.treatInteractiveAsBlocking

treatPropsAsBlocking?

Section titled “treatPropsAsBlocking?”

optional treatPropsAsBlocking?: boolean

Defined in: src/actors/actors.ts:142

Treat prop actors as movement blockers.

Inherited from

Section titled “Inherited from”

GameboardTileInspectionOptions.treatPropsAsBlocking