Skip to content
declarative-hex-worlds

GameboardActorTargetingOptions

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

Options for selecting and pathing to potential actor targets.

Extends

Section titled “Extends”

Extended by

Section titled “Extended by”

Properties

Section titled “Properties”

actorIds?

Section titled “actorIds?”

optional actorIds?: string | readonly string[]

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

Actor id or ids to include.

Inherited from

Section titled “Inherited from”

GameboardActorSelectionOptions.actorIds

approach?

Section titled “approach?”

optional approach?: GameboardActorTargetApproach

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

Target approach strategy. Defaults to nearest.

blocksMovement?

Section titled “blocksMovement?”

optional blocksMovement?: boolean

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

Filter by actor movement-blocking flag.

Inherited from

Section titled “Inherited from”

GameboardActorSelectionOptions.blocksMovement

center?

Section titled “center?”

optional center?: GameboardNeighborhoodCenter

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

Optional center used by radius filtering and distance sorting.

Inherited from

Section titled “Inherited from”

GameboardActorSelectionOptions.center

excludeTags?

Section titled “excludeTags?”

optional excludeTags?: readonly string[]

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

Actor tags that must all be absent.

Inherited from

Section titled “Inherited from”

GameboardActorSelectionOptions.excludeTags

factions?

Section titled “factions?”

optional factions?: string | readonly string[]

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

Faction id or ids to include.

Inherited from

Section titled “Inherited from”

GameboardActorSelectionOptions.factions

hostile?

Section titled “hostile?”

optional hostile?: boolean

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

Filter by actor hostile flag.

Inherited from

Section titled “Inherited from”

GameboardActorSelectionOptions.hostile

hostileToSource?

Section titled “hostileToSource?”

optional hostileToSource?: boolean

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

Filter by hostility relative to sourceActor.

Inherited from

Section titled “Inherited from”

GameboardActorSelectionOptions.hostileToSource

includeSource?

Section titled “includeSource?”

optional includeSource?: boolean

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

Include the source actor in results. Defaults to true.

Inherited from

Section titled “Inherited from”

GameboardActorSelectionOptions.includeSource

includeUnreachable?

Section titled “includeUnreachable?”

optional includeUnreachable?: boolean

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

Include unreachable targets in results. Defaults to true.

interactive?

Section titled “interactive?”

optional interactive?: boolean

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

Filter by actor interactive flag.

Inherited from

Section titled “Inherited from”

GameboardActorSelectionOptions.interactive

kinds?

Section titled “kinds?”

optional kinds?: GameboardActorKind | readonly GameboardActorKind[]

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

Actor kind or kinds to include.

Inherited from

Section titled “Inherited from”

GameboardActorSelectionOptions.kinds

maxPathCost?

Section titled “maxPathCost?”

optional maxPathCost?: number

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

Maximum accepted path cost.

Section titled “navigation?”

optional navigation?: GameboardActorNavigationOptions

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

Actor-aware navigation options.

placementIds?

Section titled “placementIds?”

optional placementIds?: string | readonly string[]

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

Placement id or ids to include.

Inherited from

Section titled “Inherited from”

GameboardActorSelectionOptions.placementIds

radius?

Section titled “radius?”

optional radius?: number

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

Maximum hex distance from center or sourceActor.

Inherited from

Section titled “Inherited from”

GameboardActorSelectionOptions.radius

sort?

Section titled “sort?”

optional sort?: GameboardActorTargetSort

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

Target result sort mode.

sourceActor

Section titled “sourceActor”

sourceActor: string | Entity

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

Source actor that will path toward selected targets.

tags?

Section titled “tags?”

optional tags?: readonly string[]

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

Actor tags that must all be present.

Inherited from

Section titled “Inherited from”

GameboardActorSelectionOptions.tags

teams?

Section titled “teams?”

optional teams?: string | readonly string[]

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

Team id or ids to include.

Inherited from

Section titled “Inherited from”

GameboardActorSelectionOptions.teams

tileKeys?

Section titled “tileKeys?”

optional tileKeys?: string | readonly string[]

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

Tile key or keys to include.

Inherited from

Section titled “Inherited from”

GameboardActorSelectionOptions.tileKeys