GameboardObjectUserData
Defined in: packages/declarative-hex-worlds/src/three/three.ts:257
User-data payload attached to rendered objects for picking and interaction.
Properties
Section titled “Properties”actorId?
Section titled “actorId?”
optionalactorId?:string
Defined in: packages/declarative-hex-worlds/src/three/three.ts:271
Actor id when the placement represents a runtime actor.
actorKind?
Section titled “actorKind?”
optionalactorKind?:string
Defined in: packages/declarative-hex-worlds/src/three/three.ts:273
Actor kind when supplied by placement metadata.
assetId
Section titled “assetId”assetId:
string
Defined in: packages/declarative-hex-worlds/src/three/three.ts:263
Source asset id.
kind:
GameboardPlacementKind
Defined in: packages/declarative-hex-worlds/src/three/three.ts:265
Placement kind from the gameboard plan.
layer:
GameboardPlacementLayer
Defined in: packages/declarative-hex-worlds/src/three/three.ts:267
Placement layer from the gameboard plan.
placementId
Section titled “placementId”placementId:
string
Defined in: packages/declarative-hex-worlds/src/three/three.ts:259
Placement id represented by this object.
requiresExtra
Section titled “requiresExtra”requiresExtra:
boolean
Defined in: packages/declarative-hex-worlds/src/three/three.ts:269
Whether this object depends on local EXTRA or external assets.
sourcePack?
Section titled “sourcePack?”
optionalsourcePack?:string
Defined in: packages/declarative-hex-worlds/src/three/three.ts:275
Source pack label for external pieces.
tileKey
Section titled “tileKey”tileKey:
string
Defined in: packages/declarative-hex-worlds/src/three/three.ts:261
Origin tile key.