GameboardScenarioActor

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

Authored actor entry in a scenario, with optional spawn group resolution.

Extends

• Omit<SpawnGameboardActorOptions, "at">

Properties

actorId

actorId: string

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

Stable gameplay actor id.

Inherited from

GameboardActorRegistrationOptions.actorId

---

actorKind?

optional actorKind?: GameboardActorKind

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

Gameplay actor kind. Defaults from placement kind.

Inherited from

GameboardActorRegistrationOptions.actorKind

---

actorMetadata?

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

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

Serializable actor metadata independent from placement metadata.

Inherited from

GameboardActorRegistrationOptions.actorMetadata

---

assetId

assetId: string

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

Manifest or external registry asset id to render.

Inherited from

SpawnGameboardPlacementOptions.assetId

---

at?

optional at?: string | HexCoordinates

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

Explicit spawn coordinate or tile key; omitted when using a spawn group.

---

blocksMovement?

optional blocksMovement?: boolean

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

Whether this actor blocks actor movement.

Inherited from

GameboardActorRegistrationOptions.blocksMovement

---

elevationOffset?

optional elevationOffset?: number

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

Extra vertical offset above the tile elevation.

Inherited from

SpawnGameboardPlacementOptions.elevationOffset

---

faction?

optional faction?: string | null

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

Optional faction identifier.

Inherited from

GameboardActorRegistrationOptions.faction

---

hostile?

optional hostile?: boolean

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

Whether this actor is generally hostile.

Inherited from

GameboardActorRegistrationOptions.hostile

---

id?

optional id?: string

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

Explicit placement id. Defaults to a deterministic runtime id.

Inherited from

SpawnGameboardPlacementOptions.id

---

interactive?

optional interactive?: boolean

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

Whether this actor should be considered an interaction target.

Inherited from

GameboardActorRegistrationOptions.interactive

---

kind

kind: GameboardPlacementKind

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

Gameplay category for rules, selectors, and rendering.

Inherited from

SpawnGameboardPlacementOptions.kind

---

layer?

optional layer?: GameboardPlacementLayer

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

Render and occupancy layer. Defaults from kind.

Inherited from

SpawnGameboardPlacementOptions.layer

---

metadata?

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.

Inherited from

SpawnGameboardPlacementOptions.metadata

---

movementAgent?

optional movementAgent?: SetGameboardMovementAgentOptions

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

Optional movement agent to attach after spawning.

---

occupancyGuard?

optional occupancyGuard?: GameboardPlacementOccupancyGuard

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

Optional occupancy validation before spawning.

Inherited from

SpawnGameboardPlacementOptions.occupancyGuard

---

order?

optional order?: number

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

Stable sort order used by renderers and snapshots.

Inherited from

SpawnGameboardPlacementOptions.order

---

patrolAgent?

optional patrolAgent?: GameboardScenarioActorPatrolAgent

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

Optional patrol agent to attach after spawning.

---

positionOffset?

optional positionOffset?: GameboardPlacementPositionOffset

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

Local world-space offset after tile/elevation anchoring.

Inherited from

SpawnGameboardPlacementOptions.positionOffset

---

requiresExtra?

optional requiresExtra?: boolean

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

Whether the placement depends on local-only EXTRA assets.

Inherited from

SpawnGameboardPlacementOptions.requiresExtra

---

rotationSteps?

optional rotationSteps?: number

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

Clockwise 60-degree rotation steps.

Inherited from

SpawnGameboardPlacementOptions.rotationSteps

---

scale?

optional scale?: number

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

Uniform render scale.

Inherited from

SpawnGameboardPlacementOptions.scale

---

spawnGroupId?

optional spawnGroupId?: string

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

Spawn group id to claim a deterministic spawn location from.

---

spawnLocationIndex?

optional spawnLocationIndex?: number

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

Explicit spawn location index inside the referenced spawn group.

---

stackIndex?

optional stackIndex?: number

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

Optional stack index for layered terrain and vertical props.

Inherited from

SpawnGameboardPlacementOptions.stackIndex

---

tags?

optional tags?: readonly string[]

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

Free-form actor tags used by selectors and quests.

Inherited from

GameboardActorRegistrationOptions.tags

---

team?

optional team?: string | null

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

Optional team identifier. Defaults to faction when omitted.

Inherited from

GameboardActorRegistrationOptions.team

---

textureSet?

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

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

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

Inherited from

SpawnGameboardPlacementOptions.textureSet