GameboardActorSelectionOptions

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

Filter options for selecting actors from the world.

Properties

actorIds?

optional actorIds?: string | readonly string[]

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

Actor id or ids to include.

---

blocksMovement?

optional blocksMovement?: boolean

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

Filter by actor movement-blocking flag.

---

center?

optional center?: GameboardNeighborhoodCenter

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

Optional center used by radius filtering and distance sorting.

---

excludeTags?

optional excludeTags?: readonly string[]

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

Actor tags that must all be absent.

---

factions?

optional factions?: string | readonly string[]

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

Faction id or ids to include.

---

hostile?

optional hostile?: boolean

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

Filter by actor hostile flag.

---

hostileToSource?

optional hostileToSource?: boolean

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

Filter by hostility relative to sourceActor.

---

includeSource?

optional includeSource?: boolean

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

Include the source actor 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.

---

kinds?

optional kinds?: GameboardActorKind | readonly GameboardActorKind[]

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

Actor kind or kinds to include.

---

placementIds?

optional placementIds?: string | readonly string[]

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

Placement id or ids to include.

---

radius?

optional radius?: number

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

Maximum hex distance from center or sourceActor.

---

sort?

optional sort?: GameboardActorSelectionSort

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

Sort mode for selected actors.

---

sourceActor?

optional sourceActor?: string | Entity

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

Source actor used for hostility and default center resolution.

---

tags?

optional tags?: readonly string[]

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

Actor tags that must all be present.

---

teams?

optional teams?: string | readonly string[]

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

Team id or ids to include.

---

tileKeys?

optional tileKeys?: string | readonly string[]

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

Tile key or keys to include.