Skip to content

ResolvedGameboardScenarioActor

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

Scenario actor after spawn group references have been resolved.

actorId: string

Defined in: src/actors/actors.ts:60

Stable gameplay actor id.

SpawnGameboardActorOptions.actorId


optional actorKind?: GameboardActorKind

Defined in: src/actors/actors.ts:62

Gameplay actor kind. Defaults from placement kind.

SpawnGameboardActorOptions.actorKind


optional actorMetadata?: Readonly<Record<string, GameboardActorMetadataValue>>

Defined in: src/actors/actors.ts:76

Serializable actor metadata independent from placement metadata.

SpawnGameboardActorOptions.actorMetadata


assetId: string

Defined in: src/koota/koota.ts:303

Manifest or external registry asset id to render.

SpawnGameboardActorOptions.assetId


at: string | HexCoordinates

Defined in: src/koota/koota.ts:301

Origin tile or tile key where the placement should spawn.

SpawnGameboardActorOptions.at


optional blocksMovement?: boolean

Defined in: src/actors/actors.ts:70

Whether this actor blocks actor movement.

SpawnGameboardActorOptions.blocksMovement


optional elevationOffset?: number

Defined in: src/koota/koota.ts:311

Extra vertical offset above the tile elevation.

SpawnGameboardActorOptions.elevationOffset


optional faction?: string | null

Defined in: src/actors/actors.ts:64

Optional faction identifier.

SpawnGameboardActorOptions.faction


optional hostile?: boolean

Defined in: src/actors/actors.ts:68

Whether this actor is generally hostile.

SpawnGameboardActorOptions.hostile


optional id?: string

Defined in: src/koota/koota.ts:299

Explicit placement id. Defaults to a deterministic runtime id.

SpawnGameboardActorOptions.id


optional interactive?: boolean

Defined in: src/actors/actors.ts:72

Whether this actor should be considered an interaction target.

SpawnGameboardActorOptions.interactive


kind: GameboardPlacementKind

Defined in: src/koota/koota.ts:305

Gameplay category for rules, selectors, and rendering.

SpawnGameboardActorOptions.kind


optional layer?: GameboardPlacementLayer

Defined in: src/koota/koota.ts:307

Render and occupancy layer. Defaults from kind.

SpawnGameboardActorOptions.layer


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

Defined in: src/koota/koota.ts:325

Serializable placement metadata for rules, ECS interop, and render hints.

SpawnGameboardActorOptions.metadata


optional movementAgent?: SetGameboardMovementAgentOptions

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

Optional movement agent to attach after spawning.


optional occupancyGuard?: GameboardPlacementOccupancyGuard

Defined in: src/koota/koota.ts:327

Optional occupancy validation before spawning.

SpawnGameboardActorOptions.occupancyGuard


optional order?: number

Defined in: src/koota/koota.ts:319

Stable sort order used by renderers and snapshots.

SpawnGameboardActorOptions.order


optional patrolAgent?: GameboardScenarioActorPatrolAgent

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

Optional patrol agent to attach after spawning.


optional positionOffset?: GameboardPlacementPositionOffset

Defined in: src/koota/koota.ts:313

Local world-space offset after tile/elevation anchoring.

SpawnGameboardActorOptions.positionOffset


optional requiresExtra?: boolean

Defined in: src/koota/koota.ts:323

Whether the placement depends on local-only EXTRA assets.

SpawnGameboardActorOptions.requiresExtra


optional rotationSteps?: number

Defined in: src/koota/koota.ts:315

Clockwise 60-degree rotation steps.

SpawnGameboardActorOptions.rotationSteps


optional scale?: number

Defined in: src/koota/koota.ts:317

Uniform render scale.

SpawnGameboardActorOptions.scale


optional spawnGroupId?: string

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

Spawn group id used to resolve the actor, when any.


optional spawnLocationId?: string

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

Spawn location id claimed inside the group, when any.


optional spawnLocationIndex?: number

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

Spawn location index claimed inside the group, when any.


optional spawnTileKey?: string

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

Spawn tile key claimed inside the group, when any.


optional stackIndex?: number

Defined in: src/koota/koota.ts:321

Optional stack index for layered terrain and vertical props.

SpawnGameboardActorOptions.stackIndex


optional tags?: readonly string[]

Defined in: src/actors/actors.ts:74

Free-form actor tags used by selectors and quests.

SpawnGameboardActorOptions.tags


optional team?: string | null

Defined in: src/actors/actors.ts:66

Optional team identifier. Defaults to faction when omitted.

SpawnGameboardActorOptions.team


optional textureSet?: "default" | "fall" | "summer" | "winter"

Defined in: src/koota/koota.ts:309

Texture set override. Defaults to the origin tile texture set.

SpawnGameboardActorOptions.textureSet