GameboardInteractionCommandExecutionOptions
Defined in: src/commands/commands.ts:230
Options for executing a command preview and optionally invoking game handlers.
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Properties
Section titled “Properties”blockingPlacementKinds?
Section titled “blockingPlacementKinds?”
optionalblockingPlacementKinds?: readonlyGameboardPlacementKind[]
Defined in: src/actors/actors.ts:132
Placement kinds that should block actor movement.
Inherited from
Section titled “Inherited from”GameboardInteractionCommandPreviewOptions.blockingPlacementKinds
blockingPlacementLayers?
Section titled “blockingPlacementLayers?”
optionalblockingPlacementLayers?: readonlyGameboardPlacementLayer[]
Defined in: src/actors/actors.ts:134
Placement layers that should block actor movement.
Inherited from
Section titled “Inherited from”GameboardInteractionCommandPreviewOptions.blockingPlacementLayers
handlers?
Section titled “handlers?”
optionalhandlers?:GameboardInteractionHandler| readonlyGameboardInteractionHandler[]
Defined in: src/commands/commands.ts:233
Handler or handler chain for non-movement interact/attack/inspect commands.
ignorePlacementIds?
Section titled “ignorePlacementIds?”
optionalignorePlacementIds?: readonlystring[]
Defined in: src/actors/actors.ts:136
Placement ids ignored during collision checks.
Inherited from
Section titled “Inherited from”GameboardInteractionCommandPreviewOptions.ignorePlacementIds
movement?
Section titled “movement?”
optionalmovement?:GameboardMovementPathRequestOptions
Defined in: src/commands/commands.ts:224
Movement path options used when the command is a move request.
Inherited from
Section titled “Inherited from”GameboardInteractionCommandPreviewOptions.movement
requireSourceActorForAttack?
Section titled “requireSourceActorForAttack?”
optionalrequireSourceActorForAttack?:boolean
Defined in: src/actors/actors.ts:579
Require a source actor before attack commands can execute.
Inherited from
Section titled “Inherited from”GameboardInteractionCommandPreviewOptions.requireSourceActorForAttack
requireSourceActorForInteraction?
Section titled “requireSourceActorForInteraction?”
optionalrequireSourceActorForInteraction?:boolean
Defined in: src/actors/actors.ts:581
Require a source actor before interaction commands can execute.
Inherited from
Section titled “Inherited from”GameboardInteractionCommandPreviewOptions.requireSourceActorForInteraction
requireSourceActorForMove?
Section titled “requireSourceActorForMove?”
optionalrequireSourceActorForMove?:boolean
Defined in: src/actors/actors.ts:577
Require a source actor before move commands can execute.
Inherited from
Section titled “Inherited from”GameboardInteractionCommandPreviewOptions.requireSourceActorForMove
sourceActor?
Section titled “sourceActor?”
optionalsourceActor?:string|Entity
Defined in: src/actors/actors.ts:222
Source actor used for hostility and collision interpretation.
Inherited from
Section titled “Inherited from”GameboardInteractionCommandPreviewOptions.sourceActor
treatHostileAsBlocking?
Section titled “treatHostileAsBlocking?”
optionaltreatHostileAsBlocking?:boolean
Defined in: src/actors/actors.ts:138
Treat hostile actors as movement blockers.
Inherited from
Section titled “Inherited from”GameboardInteractionCommandPreviewOptions.treatHostileAsBlocking
treatInteractiveAsBlocking?
Section titled “treatInteractiveAsBlocking?”
optionaltreatInteractiveAsBlocking?:boolean
Defined in: src/actors/actors.ts:140
Treat interactive actors as movement blockers.
Inherited from
Section titled “Inherited from”GameboardInteractionCommandPreviewOptions.treatInteractiveAsBlocking
treatPropsAsBlocking?
Section titled “treatPropsAsBlocking?”
optionaltreatPropsAsBlocking?:boolean
Defined in: src/actors/actors.ts:142
Treat prop actors as movement blockers.
Inherited from
Section titled “Inherited from”GameboardInteractionCommandPreviewOptions.treatPropsAsBlocking