ExternalAssetPlacementRecommendation
Defined in: src/interop/compatibility.ts:93
Placement metadata a game can apply when registering the external asset as a custom gameboard piece or runtime placement.
Properties
Section titled “Properties”anchor
Section titled “anchor”anchor:
ExternalAssetAnchor
Defined in: src/interop/compatibility.ts:115
Anchor point the recommendation assumes.
animation?
Section titled “animation?”
optionalanimation?:object
Defined in: src/interop/compatibility.ts:121
Animation recommendation when embedded clips are present.
clips: readonly
string[]
Available clip names.
defaultClip?
Section titled “defaultClip?”
optionaldefaultClip?:string
Preferred default clip for idle/walk presentation.
loop:
boolean
Whether the clip should loop by default.
source
Section titled “source”source:
"embedded"|"external"
Where clips were discovered.
blocksMovement
Section titled “blocksMovement”blocksMovement:
boolean
Defined in: src/interop/compatibility.ts:113
Whether the placement should block actor movement by default.
boardForwardEdge
Section titled “boardForwardEdge”boardForwardEdge:
HexEdgeIndex
Defined in: src/interop/compatibility.ts:119
Board edge the model is intended to face.
elevationOffset
Section titled “elevationOffset”elevationOffset:
number
Defined in: src/interop/compatibility.ts:105
Vertical offset to place the model on top of the hex surface.
facingErrorRadians
Section titled “facingErrorRadians”facingErrorRadians:
number
Defined in: src/interop/compatibility.ts:111
Remaining angle error after hex-step rotation.
footprint
Section titled “footprint”footprint:
ExternalAssetFootprintKind
Defined in: src/interop/compatibility.ts:101
Inferred footprint family.
kind:
"unit"|"prop"|"terrain"|"structure"
Defined in: src/interop/compatibility.ts:97
Gameboard placement kind to use.
layer:
"unit"|"terrain"|"structure"|"feature"
Defined in: src/interop/compatibility.ts:99
Gameboard render/collision layer to use.
modelForward
Section titled “modelForward”modelForward:
ExternalAssetForwardAxis
Defined in: src/interop/compatibility.ts:117
Model-local forward axis used for this recommendation.
Defined in: src/interop/compatibility.ts:95
Suggested high-level role.
rotationRadians
Section titled “rotationRadians”rotationRadians:
number
Defined in: src/interop/compatibility.ts:109
Rotation in radians equivalent to rotationSteps.
rotationSteps
Section titled “rotationSteps”rotationSteps:
number
Defined in: src/interop/compatibility.ts:107
60-degree rotation steps needed for best facing alignment.
scale:
number
Defined in: src/interop/compatibility.ts:103
Recommended uniform scale.