GameboardActorTargetingOptions

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:505

Options for selecting and pathing to potential actor targets.

Extends

• Omit<GameboardActorSelectionOptions, "sourceActor" | "sort">

Extended by

• GameboardActorTargetCommandOptions

Properties

actorIds?

optional actorIds?: string | readonly string[]

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:380

Actor id or ids to include.

Inherited from

GameboardActorSelectionOptions.actorIds

---

approach?

optional approach?: GameboardActorTargetApproach

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:512

Target approach strategy. Defaults to nearest.

---

blocksMovement?

optional blocksMovement?: boolean

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:408

Filter by actor movement-blocking flag.

Inherited from

GameboardActorSelectionOptions.blocksMovement

---

center?

optional center?: GameboardNeighborhoodCenter

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:396

Optional center used by radius filtering and distance sorting.

Inherited from

GameboardActorSelectionOptions.center

---

excludeTags?

optional excludeTags?: readonly string[]

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:392

Actor tags that must all be absent.

Inherited from

GameboardActorSelectionOptions.excludeTags

---

factions?

optional factions?: string | readonly string[]

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:388

Faction id or ids to include.

Inherited from

GameboardActorSelectionOptions.factions

---

hostile?

optional hostile?: boolean

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:404

Filter by actor hostile flag.

Inherited from

GameboardActorSelectionOptions.hostile

---

hostileToSource?

optional hostileToSource?: boolean

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:410

Filter by hostility relative to sourceActor.

Inherited from

GameboardActorSelectionOptions.hostileToSource

---

includeSource?

optional includeSource?: boolean

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:402

Include the source actor in results. Defaults to true.

Inherited from

GameboardActorSelectionOptions.includeSource

---

includeUnreachable?

optional includeUnreachable?: boolean

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:516

Include unreachable targets in results. Defaults to true.

---

interactive?

optional interactive?: boolean

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:406

Filter by actor interactive flag.

Inherited from

GameboardActorSelectionOptions.interactive

---

kinds?

optional kinds?: GameboardActorKind | readonly GameboardActorKind[]

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:384

Actor kind or kinds to include.

Inherited from

GameboardActorSelectionOptions.kinds

---

maxPathCost?

optional maxPathCost?: number

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:514

Maximum accepted path cost.

---

navigation?

optional navigation?: GameboardActorNavigationOptions

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:510

Actor-aware navigation options.

---

placementIds?

optional placementIds?: string | readonly string[]

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:382

Placement id or ids to include.

Inherited from

GameboardActorSelectionOptions.placementIds

---

radius?

optional radius?: number

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:398

Maximum hex distance from center or sourceActor.

Inherited from

GameboardActorSelectionOptions.radius

---

sort?

optional sort?: GameboardActorTargetSort

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:518

Target result sort mode.

---

sourceActor

sourceActor: string | Entity

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:508

Source actor that will path toward selected targets.

---

tags?

optional tags?: readonly string[]

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:390

Actor tags that must all be present.

Inherited from

GameboardActorSelectionOptions.tags

---

teams?

optional teams?: string | readonly string[]

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:386

Team id or ids to include.

Inherited from

GameboardActorSelectionOptions.teams

---

tileKeys?

optional tileKeys?: string | readonly string[]

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:394

Tile key or keys to include.

Inherited from

GameboardActorSelectionOptions.tileKeys