Skip to content
declarative-hex-worlds

GameboardScenario

Defined in: src/scenario/scenario.ts:96

Serializable integration/e2e scenario using recipes, actors, routes, and quests.

Properties

Section titled “Properties”

actors?

Section titled “actors?”

optional actors?: readonly GameboardScenarioActor[]

Defined in: src/scenario/scenario.ts:110

Actors to spawn into the scenario runtime.

board

Section titled “board”

board: GameboardRecipe

Defined in: src/scenario/scenario.ts:104

Board recipe used to compile the scenario map.

id

Section titled “id”

id: string

Defined in: src/scenario/scenario.ts:100

Stable scenario id.

metadata?

Section titled “metadata?”

optional metadata?: Readonly<Record<string, string | number | boolean | null>>

Defined in: src/scenario/scenario.ts:114

Additional serializable scenario metadata.

patrolRoutes?

Section titled “patrolRoutes?”

optional patrolRoutes?: readonly GameboardScenarioPatrolRoute[]

Defined in: src/scenario/scenario.ts:108

Deterministic patrol route rules for scenario actors.

quests?

Section titled “quests?”

optional quests?: readonly GameboardQuestDefinition[]

Defined in: src/scenario/scenario.ts:112

Quests to spawn into the scenario runtime.

schemaVersion

Section titled “schemaVersion”

schemaVersion: "1.0.0"

Defined in: src/scenario/scenario.ts:98

Version tag for migration-safe scenario persistence.

spawnGroups?

Section titled “spawnGroups?”

optional spawnGroups?: GameboardSpawnGroupOptions

Defined in: src/scenario/scenario.ts:106

Deterministic spawn group rules for scenario actors.

title?

Section titled “title?”

optional title?: string

Defined in: src/scenario/scenario.ts:102

Optional display title.