Skip to content
declarative-hex-worlds

GameboardActorSelectionOptions

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

Filter options for selecting actors from the world.

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.

blocksMovement?

Section titled “blocksMovement?”

optional blocksMovement?: boolean

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

Filter by actor movement-blocking flag.

center?

Section titled “center?”

optional center?: GameboardNeighborhoodCenter

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

Optional center used by radius filtering and distance sorting.

excludeTags?

Section titled “excludeTags?”

optional excludeTags?: readonly string[]

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

Actor tags that must all be absent.

factions?

Section titled “factions?”

optional factions?: string | readonly string[]

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

Faction id or ids to include.

hostile?

Section titled “hostile?”

optional hostile?: boolean

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

Filter by actor hostile flag.

hostileToSource?

Section titled “hostileToSource?”

optional hostileToSource?: boolean

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

Filter by hostility relative to sourceActor.

includeSource?

Section titled “includeSource?”

optional includeSource?: boolean

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

Include the source actor in results. Defaults to true.

interactive?

Section titled “interactive?”

optional interactive?: boolean

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

Filter by actor interactive flag.

kinds?

Section titled “kinds?”

optional kinds?: GameboardActorKind | readonly GameboardActorKind[]

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

Actor kind or kinds to include.

placementIds?

Section titled “placementIds?”

optional placementIds?: string | readonly string[]

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

Placement id or ids to include.

radius?

Section titled “radius?”

optional radius?: number

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

Maximum hex distance from center or sourceActor.

sort?

Section titled “sort?”

optional sort?: GameboardActorSelectionSort

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

Sort mode for selected actors.

sourceActor?

Section titled “sourceActor?”

optional sourceActor?: string | Entity

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

Source actor used for hostility and default center resolution.

tags?

Section titled “tags?”

optional tags?: readonly string[]

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

Actor tags that must all be present.

teams?

Section titled “teams?”

optional teams?: string | readonly string[]

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

Team id or ids to include.

tileKeys?

Section titled “tileKeys?”

optional tileKeys?: string | readonly string[]

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

Tile key or keys to include.