GameboardInteractionHandlerEffect
GameboardInteractionHandlerEffect = {
actorId:string;placementId?:string;reason?:string;removed:boolean;type:"actor-removed"; } | {placementId:string;reason?:string;removed:boolean;type:"placement-removed"; } | {actorId:string;placementId?:string;reason?:string;type:"actor-updated";updated:boolean; } | {placementId:string;reason?:string;type:"placement-updated";updated:boolean; }
Defined in: src/commands/commands.ts:69
Serializable side effect emitted by a command handler.
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ actorId: string; placementId?: string; reason?: string; removed: boolean; type: "actor-removed"; }
actorId
Section titled “actorId”actorId:
string
Actor id that the handler attempted to remove.
placementId?
Section titled “placementId?”
optionalplacementId?:string
Placement id associated with the removed actor.
reason?
Section titled “reason?”
optionalreason?:string
Optional failure or diagnostic reason.
removed
Section titled “removed”removed:
boolean
Whether the actor placement was removed.
type:
"actor-removed"
Effect discriminator for removing an actor placement.
Type Literal
Section titled “Type Literal”{ placementId: string; reason?: string; removed: boolean; type: "placement-removed"; }
placementId
Section titled “placementId”placementId:
string
Placement id that the handler attempted to remove.
reason?
Section titled “reason?”
optionalreason?:string
Optional failure or diagnostic reason.
removed
Section titled “removed”removed:
boolean
Whether the placement was removed.
type:
"placement-removed"
Effect discriminator for removing a non-actor placement.
Type Literal
Section titled “Type Literal”{ actorId: string; placementId?: string; reason?: string; type: "actor-updated"; updated: boolean; }
actorId
Section titled “actorId”actorId:
string
Actor id that the handler attempted to update.
placementId?
Section titled “placementId?”
optionalplacementId?:string
Placement id associated with the actor.
reason?
Section titled “reason?”
optionalreason?:string
Optional failure or diagnostic reason.
type:
"actor-updated"
Effect discriminator for actor metadata updates.
updated
Section titled “updated”updated:
boolean
Whether actor state was updated.
Type Literal
Section titled “Type Literal”{ placementId: string; reason?: string; type: "placement-updated"; updated: boolean; }
placementId
Section titled “placementId”placementId:
string
Placement id that the handler attempted to update.
reason?
Section titled “reason?”
optionalreason?:string
Optional failure or diagnostic reason.
type:
"placement-updated"
Effect discriminator for placement metadata updates.
updated
Section titled “updated”updated:
boolean
Whether placement state was updated.