Skip to content
declarative-hex-worlds

CreateGameboardPatrolSimulationScriptOptions

Defined in: packages/declarative-hex-worlds/src/simulation/script-types.ts:678

Options for generating a complete simulation script from patrol routes.

Extends

Section titled “Extends”

Properties

Section titled “Properties”

assignments

Section titled “assignments”

assignments: readonly GameboardPatrolSimulationActorAssignment[]

Defined in: packages/declarative-hex-worlds/src/simulation/script-types.ts:632

Actor-to-route assignments.

Inherited from

Section titled “Inherited from”

CreateGameboardPatrolSimulationStepsOptions.assignments

defaultCommandHandlerOptions?

Section titled “defaultCommandHandlerOptions?”

optional defaultCommandHandlerOptions?: CreateGameboardInteractionHandlerPresetOptions

Defined in: packages/declarative-hex-worlds/src/simulation/script-types.ts:687

Default handler options for generated script.

defaultCommandHandlers?

Section titled “defaultCommandHandlers?”

optional defaultCommandHandlers?: readonly ("remove-target-actor" | "remove-target-placement" | "mark-target-interacted" | "default-rpg")[]

Defined in: packages/declarative-hex-worlds/src/simulation/script-types.ts:685

Default command handler presets for generated script.

defaultCommandSystems?

Section titled “defaultCommandSystems?”

optional defaultCommandSystems?: false | RunGameboardSystemsOptions

Defined in: packages/declarative-hex-worlds/src/simulation/script-types.ts:683

Default command systems for generated script.

defaultRunSystems?

Section titled “defaultRunSystems?”

optional defaultRunSystems?: RunGameboardSystemsOptions

Defined in: packages/declarative-hex-worlds/src/simulation/script-types.ts:689

Default systems for generated run-systems steps.

defaultSourceActor?

Section titled “defaultSourceActor?”

optional defaultSourceActor?: string

Defined in: packages/declarative-hex-worlds/src/simulation/script-types.ts:681

Default source actor id for generated command steps.

expectations?

Section titled “expectations?”

optional expectations?: GameboardScenarioSimulationExpectations

Defined in: packages/declarative-hex-worlds/src/simulation/script-types.ts:691

Expectations to embed in the generated script.

requireFoundRoutes?

Section titled “requireFoundRoutes?”

optional requireFoundRoutes?: boolean

Defined in: packages/declarative-hex-worlds/src/simulation/script-types.ts:634

Whether missing routes should be treated as errors. Defaults to true.

Inherited from

Section titled “Inherited from”

CreateGameboardPatrolSimulationStepsOptions.requireFoundRoutes

routes

Section titled “routes”

routes: GameboardPatrolRouteSet | readonly GameboardPatrolRoutePlan[]

Defined in: packages/declarative-hex-worlds/src/simulation/script-types.ts:630

Patrol route set or route plans.

Inherited from

Section titled “Inherited from”

CreateGameboardPatrolSimulationStepsOptions.routes