Skip to content
declarative-hex-worlds

GameboardScenarioSimulationCommandStep

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

Runs an interaction command against a target.

Extends

Section titled “Extends”

Properties

Section titled “Properties”

action

Section titled “action”

action: "command"

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

Step discriminator.

command?

Section titled “command?”

optional command?: Omit<RunGameboardInteractionOptions, "systems" | "handlers">

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

Command execution options excluding systems and handlers.

handler?

Section titled “handler?”

optional handler?: "remove-target-actor" | "remove-target-placement" | "mark-target-interacted" | "default-rpg"

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

Single built-in command handler preset.

handlerOptions?

Section titled “handlerOptions?”

optional handlerOptions?: CreateGameboardInteractionHandlerPresetOptions

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

Options for built-in command handler presets.

handlers?

Section titled “handlers?”

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

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

Built-in command handler presets.

id?

Section titled “id?”

optional id?: string

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

Optional stable step id used by reports and expectations.

Inherited from

Section titled “Inherited from”

GameboardScenarioSimulationStepBase.id

label?

Section titled “label?”

optional label?: string

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

Human-readable step label for reports.

Inherited from

Section titled “Inherited from”

GameboardScenarioSimulationStepBase.label

sourceActor?

Section titled “sourceActor?”

optional sourceActor?: string

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

Source actor id used when the target must be planned.

systems?

Section titled “systems?”

optional systems?: false | RunGameboardSystemsOptions

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

Systems to run after command dispatch, or false to skip.

target

Section titled “target”

target: GameboardInteractionCommandInput

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

Command target or already-planned command.