Skip to content

GameboardActorRegistrationOptions

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

Options for attaching gameplay actor state to an existing placement.

actorId: string

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

Stable gameplay actor id.


optional actorKind?: GameboardActorKind

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

Gameplay actor kind. Defaults from placement kind.


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

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

Serializable actor metadata independent from placement metadata.


optional blocksMovement?: boolean

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

Whether this actor blocks actor movement.


optional faction?: string | null

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

Optional faction identifier.


optional hostile?: boolean

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

Whether this actor is generally hostile.


optional interactive?: boolean

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

Whether this actor should be considered an interaction target.


optional tags?: readonly string[]

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

Free-form actor tags used by selectors and quests.


optional team?: string | null

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

Optional team identifier. Defaults to faction when omitted.