GameboardActorTargetCommandOptions

Defined in: src/commands/commands.ts:239

Options for choosing an actor target and planning a command against it.

Extends

• GameboardActorTargetingOptions

Properties

actorIds?

optional actorIds?: string | readonly string[]

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

Actor id or ids to include.

Inherited from

GameboardActorSelectionOptions.actorIds

---

approach?

optional approach?: GameboardActorTargetApproach

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

Target approach strategy. Defaults to nearest.

Inherited from

GameboardActorTargetingOptions.approach

---

blocksMovement?

optional blocksMovement?: boolean

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

Filter by actor movement-blocking flag.

Inherited from

GameboardActorSelectionOptions.blocksMovement

---

center?

optional center?: GameboardNeighborhoodCenter

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

Optional center used by radius filtering and distance sorting.

Inherited from

GameboardActorSelectionOptions.center

---

excludeTags?

optional excludeTags?: readonly string[]

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

Actor tags that must all be absent.

Inherited from

GameboardActorSelectionOptions.excludeTags

---

factions?

optional factions?: string | readonly string[]

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

Faction id or ids to include.

Inherited from

GameboardActorSelectionOptions.factions

---

hostile?

optional hostile?: boolean

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

Filter by actor hostile flag.

Inherited from

GameboardActorSelectionOptions.hostile

---

hostileToSource?

optional hostileToSource?: boolean

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

Filter by hostility relative to sourceActor.

Inherited from

GameboardActorSelectionOptions.hostileToSource

---

includeSource?

optional includeSource?: boolean

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

Include the source actor in results. Defaults to true.

Inherited from

GameboardActorSelectionOptions.includeSource

---

includeUnreachable?

optional includeUnreachable?: boolean

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

Include unreachable targets in results. Defaults to true.

Inherited from

GameboardActorTargetingOptions.includeUnreachable

---

interactive?

optional interactive?: boolean

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

Filter by actor interactive flag.

Inherited from

GameboardActorSelectionOptions.interactive

---

kinds?

optional kinds?: GameboardActorKind | readonly GameboardActorKind[]

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

Actor kind or kinds to include.

Inherited from

GameboardActorSelectionOptions.kinds

---

maxPathCost?

optional maxPathCost?: number

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

Maximum accepted path cost.

Inherited from

GameboardActorTargetingOptions.maxPathCost

---

navigation?

optional navigation?: GameboardActorNavigationOptions

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

Actor-aware navigation options.

Inherited from

GameboardActorTargetingOptions.navigation

---

placementIds?

optional placementIds?: string | readonly string[]

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

Placement id or ids to include.

Inherited from

GameboardActorSelectionOptions.placementIds

---

radius?

optional radius?: number

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

Maximum hex distance from center or sourceActor.

Inherited from

GameboardActorSelectionOptions.radius

---

requireReachable?

optional requireReachable?: boolean

Defined in: src/commands/commands.ts:243

Require the selected actor target to be reachable. Defaults to true.

---

sort?

optional sort?: GameboardActorTargetSort

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

Target result sort mode.

Inherited from

GameboardActorTargetingOptions.sort

---

sourceActor

sourceActor: string | Entity

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

Source actor that will path toward selected targets.

Inherited from

GameboardActorTargetCommandOptions.sourceActor

---

tags?

optional tags?: readonly string[]

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

Actor tags that must all be present.

Inherited from

GameboardActorSelectionOptions.tags

---

targetActorId?

optional targetActorId?: string

Defined in: src/commands/commands.ts:241

Require this exact target actor id instead of using the nearest match.

---

teams?

optional teams?: string | readonly string[]

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

Team id or ids to include.

Inherited from

GameboardActorSelectionOptions.teams

---

tileKeys?

optional tileKeys?: string | readonly string[]

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

Tile key or keys to include.

Inherited from

GameboardActorSelectionOptions.tileKeys