Skip to content
declarative-hex-worlds

GameboardSimulationRelationRecord

Defined in: src/interop/interop.ts:350

Relation payload for simulation timeline entities.

Properties

Section titled “Properties”

actorId?

Section titled “actorId?”

optional actorId?: string

Defined in: src/interop/interop.ts:362

Related actor id.

commandKind?

Section titled “commandKind?”

optional commandKind?: GameboardInteractionCommandKind

Defined in: src/interop/interop.ts:366

Command kind, when related to a command.

commandStatus?

Section titled “commandStatus?”

optional commandStatus?: GameboardInteractionExecutionStatus

Defined in: src/interop/interop.ts:368

Command status, when related to a command.

effectType?

Section titled “effectType?”

optional effectType?: "actor-removed" | "placement-removed" | "actor-updated" | "placement-updated"

Defined in: src/interop/interop.ts:390

Individual command effect type.

effectTypes?

Section titled “effectTypes?”

optional effectTypes?: readonly ("actor-removed" | "placement-removed" | "actor-updated" | "placement-updated")[]

Defined in: src/interop/interop.ts:374

Command effect types.

handlerId?

Section titled “handlerId?”

optional handlerId?: string

Defined in: src/interop/interop.ts:370

Handler id, when a command handler ran.

handlerStatus?

Section titled “handlerStatus?”

optional handlerStatus?: GameboardInteractionHandlerStatus

Defined in: src/interop/interop.ts:372

Handler status, when a command handler ran.

mutationType?

Section titled “mutationType?”

optional mutationType?: "actor-removed" | "placement-removed" | "actor-updated" | "placement-updated" | "actor-spawned" | "placement-spawned"

Defined in: src/interop/interop.ts:376

Mutation type, when related to a mutation.

placementId?

Section titled “placementId?”

optional placementId?: string

Defined in: src/interop/interop.ts:364

Related placement id.

recordId?

Section titled “recordId?”

optional recordId?: string

Defined in: src/interop/interop.ts:360

Timeline record id.

role

Section titled “role”

role: GameboardSimulationRelationRole

Defined in: src/interop/interop.ts:354

Simulation relation role.

scenarioId

Section titled “scenarioId”

scenarioId: string

Defined in: src/interop/interop.ts:352

Scenario id that produced the simulation.

stepId?

Section titled “stepId?”

optional stepId?: string

Defined in: src/interop/interop.ts:358

Simulation step entity id.

stepIndex?

Section titled “stepIndex?”

optional stepIndex?: number

Defined in: src/interop/interop.ts:356

Simulation step index.

targetApproach?

Section titled “targetApproach?”

optional targetApproach?: GameboardActorTargetApproach | "self" | "none"

Defined in: src/interop/interop.ts:380

Approach mode for an actor target.

targetApproachTileKey?

Section titled “targetApproachTileKey?”

optional targetApproachTileKey?: string

Defined in: src/interop/interop.ts:382

Approach tile key for an actor target.

targetCommandCanExecute?

Section titled “targetCommandCanExecute?”

optional targetCommandCanExecute?: boolean

Defined in: src/interop/interop.ts:388

Whether the target command can execute.

targetCommandKind?

Section titled “targetCommandKind?”

optional targetCommandKind?: GameboardInteractionCommandKind

Defined in: src/interop/interop.ts:386

Command kind planned for an actor target.

targetPathCost?

Section titled “targetPathCost?”

optional targetPathCost?: number

Defined in: src/interop/interop.ts:384

Path cost for an actor target.

targetReachable?

Section titled “targetReachable?”

optional targetReachable?: boolean

Defined in: src/interop/interop.ts:378

Whether an actor target was reachable.