ResolvedGameboardScenarioActor
Defined in: src/scenario/scenario.ts:70
Scenario actor after spawn group references have been resolved.
Extends
Section titled “Extends”Properties
Section titled “Properties”actorId
Section titled “actorId”actorId:
string
Defined in: src/actors/actors.ts:60
Stable gameplay actor id.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.actorId
actorKind?
Section titled “actorKind?”
optionalactorKind?:GameboardActorKind
Defined in: src/actors/actors.ts:62
Gameplay actor kind. Defaults from placement kind.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.actorKind
actorMetadata?
Section titled “actorMetadata?”
optionalactorMetadata?:Readonly<Record<string,GameboardActorMetadataValue>>
Defined in: src/actors/actors.ts:76
Serializable actor metadata independent from placement metadata.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.actorMetadata
assetId
Section titled “assetId”assetId:
string
Defined in: src/koota/koota.ts:303
Manifest or external registry asset id to render.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.assetId
at:
string|HexCoordinates
Defined in: src/koota/koota.ts:301
Origin tile or tile key where the placement should spawn.
Inherited from
Section titled “Inherited from”blocksMovement?
Section titled “blocksMovement?”
optionalblocksMovement?:boolean
Defined in: src/actors/actors.ts:70
Whether this actor blocks actor movement.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.blocksMovement
elevationOffset?
Section titled “elevationOffset?”
optionalelevationOffset?:number
Defined in: src/koota/koota.ts:311
Extra vertical offset above the tile elevation.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.elevationOffset
faction?
Section titled “faction?”
optionalfaction?:string|null
Defined in: src/actors/actors.ts:64
Optional faction identifier.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.faction
hostile?
Section titled “hostile?”
optionalhostile?:boolean
Defined in: src/actors/actors.ts:68
Whether this actor is generally hostile.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.hostile
optionalid?:string
Defined in: src/koota/koota.ts:299
Explicit placement id. Defaults to a deterministic runtime id.
Inherited from
Section titled “Inherited from”interactive?
Section titled “interactive?”
optionalinteractive?:boolean
Defined in: src/actors/actors.ts:72
Whether this actor should be considered an interaction target.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.interactive
kind:
GameboardPlacementKind
Defined in: src/koota/koota.ts:305
Gameplay category for rules, selectors, and rendering.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.kind
layer?
Section titled “layer?”
optionallayer?:GameboardPlacementLayer
Defined in: src/koota/koota.ts:307
Render and occupancy layer. Defaults from kind.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.layer
metadata?
Section titled “metadata?”
optionalmetadata?:Readonly<Record<string,string|number|boolean|null>>
Defined in: src/koota/koota.ts:325
Serializable placement metadata for rules, ECS interop, and render hints.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.metadata
movementAgent?
Section titled “movementAgent?”
optionalmovementAgent?:SetGameboardMovementAgentOptions
Defined in: src/scenario/scenario.ts:80
Optional movement agent to attach after spawning.
occupancyGuard?
Section titled “occupancyGuard?”
optionaloccupancyGuard?:GameboardPlacementOccupancyGuard
Defined in: src/koota/koota.ts:327
Optional occupancy validation before spawning.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.occupancyGuard
order?
Section titled “order?”
optionalorder?:number
Defined in: src/koota/koota.ts:319
Stable sort order used by renderers and snapshots.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.order
patrolAgent?
Section titled “patrolAgent?”
optionalpatrolAgent?:GameboardScenarioActorPatrolAgent
Defined in: src/scenario/scenario.ts:82
Optional patrol agent to attach after spawning.
positionOffset?
Section titled “positionOffset?”
optionalpositionOffset?:GameboardPlacementPositionOffset
Defined in: src/koota/koota.ts:313
Local world-space offset after tile/elevation anchoring.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.positionOffset
requiresExtra?
Section titled “requiresExtra?”
optionalrequiresExtra?:boolean
Defined in: src/koota/koota.ts:323
Whether the placement depends on local-only EXTRA assets.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.requiresExtra
rotationSteps?
Section titled “rotationSteps?”
optionalrotationSteps?:number
Defined in: src/koota/koota.ts:315
Clockwise 60-degree rotation steps.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.rotationSteps
scale?
Section titled “scale?”
optionalscale?:number
Defined in: src/koota/koota.ts:317
Uniform render scale.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.scale
spawnGroupId?
Section titled “spawnGroupId?”
optionalspawnGroupId?:string
Defined in: src/scenario/scenario.ts:72
Spawn group id used to resolve the actor, when any.
spawnLocationId?
Section titled “spawnLocationId?”
optionalspawnLocationId?:string
Defined in: src/scenario/scenario.ts:76
Spawn location id claimed inside the group, when any.
spawnLocationIndex?
Section titled “spawnLocationIndex?”
optionalspawnLocationIndex?:number
Defined in: src/scenario/scenario.ts:74
Spawn location index claimed inside the group, when any.
spawnTileKey?
Section titled “spawnTileKey?”
optionalspawnTileKey?:string
Defined in: src/scenario/scenario.ts:78
Spawn tile key claimed inside the group, when any.
stackIndex?
Section titled “stackIndex?”
optionalstackIndex?:number
Defined in: src/koota/koota.ts:321
Optional stack index for layered terrain and vertical props.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.stackIndex
optionaltags?: readonlystring[]
Defined in: src/actors/actors.ts:74
Free-form actor tags used by selectors and quests.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.tags
optionalteam?:string|null
Defined in: src/actors/actors.ts:66
Optional team identifier. Defaults to faction when omitted.
Inherited from
Section titled “Inherited from”SpawnGameboardActorOptions.team
textureSet?
Section titled “textureSet?”
optionaltextureSet?:"default"|"fall"|"summer"|"winter"
Defined in: src/koota/koota.ts:309
Texture set override. Defaults to the origin tile texture set.