GameboardInteractionCommandRecord
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:233
Serializable command execution record.
Properties
Section titled “Properties”actorId?
Section titled “actorId?”
optionalactorId?:string
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:259
Target actor id, when applicable.
canExecute
Section titled “canExecute”canExecute:
boolean
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:241
Whether the command could execute at dispatch time.
effects?
Section titled “effects?”
optionaleffects?: readonlyGameboardInteractionHandlerEffect[]
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:253
Full handler side effects.
effectTypes?
Section titled “effectTypes?”
optionaleffectTypes?: readonly ("actor-removed"|"placement-removed"|"actor-updated"|"placement-updated")[]
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:251
Side-effect type list for compact reporting.
handlerId?
Section titled “handlerId?”
optionalhandlerId?:string
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:245
Handler id when a handler processed the command.
handlerMetadata?
Section titled “handlerMetadata?”
optionalhandlerMetadata?:Readonly<Record<string,GameboardActorMetadataValue>>
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:249
Handler metadata when supplied.
handlerStatus?
Section titled “handlerStatus?”
optionalhandlerStatus?:GameboardInteractionHandlerStatus
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:247
Handler status when a handler processed the command.
intent
Section titled “intent”intent:
GameboardInteractionIntent
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:237
Command intent.
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:235
Command kind.
placementId?
Section titled “placementId?”
optionalplacementId?:string
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:257
Target placement id, when applicable.
reason?
Section titled “reason?”
optionalreason?:string
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:243
Optional blocked or handler reason.
sourceActorId?
Section titled “sourceActorId?”
optionalsourceActorId?:string
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:261
Source actor id, when applicable.
sourcePlacementId?
Section titled “sourcePlacementId?”
optionalsourcePlacementId?:string
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:263
Source placement id, when applicable.
status
Section titled “status”Defined in: packages/declarative-hex-worlds/src/systems/events.ts:239
Execution status.
target
Section titled “target”target:
object
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:265
Resolved target summary.
actorId?
Section titled “actorId?”
optionalactorId?:string
Target actor id.
canEnter
Section titled “canEnter”canEnter:
boolean
Whether the source can enter the target tile.
intent
Section titled “intent”intent:
GameboardInteractionIntent
Target intent.
Target kind.
placementId?
Section titled “placementId?”
optionalplacementId?:string
Target placement id.
tileKey?
Section titled “tileKey?”
optionaltileKey?:string
Target tile key.
tileKey?
Section titled “tileKey?”
optionaltileKey?:string
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:255
Target tile key, when applicable.