SpawnGameboardActorOptions

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:100

Options for spawning a placement and registering it as an actor in one call.

Extends

• SpawnGameboardPlacementOptions.GameboardActorRegistrationOptions

Extended by

• ResolvedGameboardScenarioActor

Properties

actorId

actorId: string

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:54

Stable gameplay actor id.

Inherited from

GameboardActorRegistrationOptions.actorId

---

actorKind?

optional actorKind?: GameboardActorKind

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:56

Gameplay actor kind. Defaults from placement kind.

Inherited from

GameboardActorRegistrationOptions.actorKind

---

actorMetadata?

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

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:70

Serializable actor metadata independent from placement metadata.

Inherited from

GameboardActorRegistrationOptions.actorMetadata

---

assetId

assetId: string

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:302

Manifest or external registry asset id to render.

Inherited from

SpawnGameboardPlacementOptions.assetId

---

at

at: string | HexCoordinates

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:300

Origin tile or tile key where the placement should spawn.

Inherited from

SpawnGameboardPlacementOptions.at

---

blocksMovement?

optional blocksMovement?: boolean

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:64

Whether this actor blocks actor movement.

Inherited from

GameboardActorRegistrationOptions.blocksMovement

---

elevationOffset?

optional elevationOffset?: number

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:310

Extra vertical offset above the tile elevation.

Inherited from

SpawnGameboardPlacementOptions.elevationOffset

---

faction?

optional faction?: string | null

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:58

Optional faction identifier.

Inherited from

GameboardActorRegistrationOptions.faction

---

hostile?

optional hostile?: boolean

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:62

Whether this actor is generally hostile.

Inherited from

GameboardActorRegistrationOptions.hostile

---

id?

optional id?: string

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:298

Explicit placement id. Defaults to a deterministic runtime id.

Inherited from

SpawnGameboardPlacementOptions.id

---

interactive?

optional interactive?: boolean

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:66

Whether this actor should be considered an interaction target.

Inherited from

GameboardActorRegistrationOptions.interactive

---

kind

kind: GameboardPlacementKind

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:304

Gameplay category for rules, selectors, and rendering.

Inherited from

SpawnGameboardPlacementOptions.kind

---

layer?

optional layer?: GameboardPlacementLayer

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:306

Render and occupancy layer. Defaults from kind.

Inherited from

SpawnGameboardPlacementOptions.layer

---

metadata?

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

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:324

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

Inherited from

SpawnGameboardPlacementOptions.metadata

---

occupancyGuard?

optional occupancyGuard?: GameboardPlacementOccupancyGuard

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:326

Optional occupancy validation before spawning.

Inherited from

SpawnGameboardPlacementOptions.occupancyGuard

---

order?

optional order?: number

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:318

Stable sort order used by renderers and snapshots.

Inherited from

SpawnGameboardPlacementOptions.order

---

positionOffset?

optional positionOffset?: GameboardPlacementPositionOffset

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:312

Local world-space offset after tile/elevation anchoring.

Inherited from

SpawnGameboardPlacementOptions.positionOffset

---

requiresExtra?

optional requiresExtra?: boolean

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:322

Whether the placement depends on local-only EXTRA assets.

Inherited from

SpawnGameboardPlacementOptions.requiresExtra

---

rotationSteps?

optional rotationSteps?: number

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:314

Clockwise 60-degree rotation steps.

Inherited from

SpawnGameboardPlacementOptions.rotationSteps

---

scale?

optional scale?: number

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:316

Uniform render scale.

Inherited from

SpawnGameboardPlacementOptions.scale

---

stackIndex?

optional stackIndex?: number

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:320

Optional stack index for layered terrain and vertical props.

Inherited from

SpawnGameboardPlacementOptions.stackIndex

---

tags?

optional tags?: readonly string[]

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:68

Free-form actor tags used by selectors and quests.

Inherited from

GameboardActorRegistrationOptions.tags

---

team?

optional team?: string | null

Defined in: packages/declarative-hex-worlds/src/actors/actors.ts:60

Optional team identifier. Defaults to faction when omitted.

Inherited from

GameboardActorRegistrationOptions.team

---

textureSet?

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

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:308

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

Inherited from

SpawnGameboardPlacementOptions.textureSet