Skip to content
declarative-hex-worlds

DispatchGameboardInteractionCommandOptions

Defined in: packages/declarative-hex-worlds/src/systems/command-dispatch.ts:26

Command dispatch options used by system helpers.

Extends

Section titled “Extends”

Extended by

Section titled “Extended by”

Properties

Section titled “Properties”

blockingPlacementKinds?

Section titled “blockingPlacementKinds?”

optional blockingPlacementKinds?: readonly GameboardPlacementKind[]

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

Placement kinds that should block actor movement.

Inherited from

Section titled “Inherited from”

GameboardInteractionCommandExecutionOptions.blockingPlacementKinds

blockingPlacementLayers?

Section titled “blockingPlacementLayers?”

optional blockingPlacementLayers?: readonly GameboardPlacementLayer[]

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

Placement layers that should block actor movement.

Inherited from

Section titled “Inherited from”

GameboardInteractionCommandExecutionOptions.blockingPlacementLayers

handlers?

Section titled “handlers?”

optional handlers?: GameboardInteractionHandler | readonly GameboardInteractionHandler[]

Defined in: packages/declarative-hex-worlds/src/commands/commands.ts:240

Handler or handler chain for non-movement interact/attack/inspect commands.

Inherited from

Section titled “Inherited from”

GameboardInteractionCommandExecutionOptions.handlers

ignorePlacementIds?

Section titled “ignorePlacementIds?”

optional ignorePlacementIds?: readonly string[]

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

Placement ids ignored during collision checks.

Inherited from

Section titled “Inherited from”

GameboardInteractionCommandExecutionOptions.ignorePlacementIds

movement?

Section titled “movement?”

optional movement?: GameboardMovementPathRequestOptions

Defined in: packages/declarative-hex-worlds/src/commands/commands.ts:231

Movement path options used when the command is a move request.

Inherited from

Section titled “Inherited from”

GameboardInteractionCommandExecutionOptions.movement

requireSourceActorForAttack?

Section titled “requireSourceActorForAttack?”

optional requireSourceActorForAttack?: boolean

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

Require a source actor before attack commands can execute.

Inherited from

Section titled “Inherited from”

GameboardInteractionCommandExecutionOptions.requireSourceActorForAttack

requireSourceActorForInteraction?

Section titled “requireSourceActorForInteraction?”

optional requireSourceActorForInteraction?: boolean

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

Require a source actor before interaction commands can execute.

Inherited from

Section titled “Inherited from”

GameboardInteractionCommandExecutionOptions.requireSourceActorForInteraction

requireSourceActorForMove?

Section titled “requireSourceActorForMove?”

optional requireSourceActorForMove?: boolean

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

Require a source actor before move commands can execute.

Inherited from

Section titled “Inherited from”

GameboardInteractionCommandExecutionOptions.requireSourceActorForMove

sourceActor?

Section titled “sourceActor?”

optional sourceActor?: string | Entity

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

Source actor used for hostility and collision interpretation.

Inherited from

Section titled “Inherited from”

GameboardInteractionCommandExecutionOptions.sourceActor

treatHostileAsBlocking?

Section titled “treatHostileAsBlocking?”

optional treatHostileAsBlocking?: boolean

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

Treat hostile actors as movement blockers.

Inherited from

Section titled “Inherited from”

GameboardInteractionCommandExecutionOptions.treatHostileAsBlocking

treatInteractiveAsBlocking?

Section titled “treatInteractiveAsBlocking?”

optional treatInteractiveAsBlocking?: boolean

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

Treat interactive actors as movement blockers.

Inherited from

Section titled “Inherited from”

GameboardInteractionCommandExecutionOptions.treatInteractiveAsBlocking

treatPropsAsBlocking?

Section titled “treatPropsAsBlocking?”

optional treatPropsAsBlocking?: boolean

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

Treat prop actors as movement blockers.

Inherited from

Section titled “Inherited from”

GameboardInteractionCommandExecutionOptions.treatPropsAsBlocking