SpineModuleController
Defined in: spine/SpineController.ts:51
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SpineModuleController(
raw,api):SpineModuleController
Defined in: spine/SpineController.ts:56
Parameters
Section titled “Parameters”SpineWasmModule
SpineWrappedAPI
Returns
Section titled “Returns”SpineModuleController
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get raw():
SpineWasmModule
Defined in: spine/SpineController.ts:66
Returns
Section titled “Returns”SpineWasmModule
Methods
Section titled “Methods”addAnimation()
Section titled “addAnimation()”addAnimation(
instanceId,animation,loop?,delay?,track?):boolean
Defined in: spine/SpineController.ts:150
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
animation
Section titled “animation”string
boolean = true
delay?
Section titled “delay?”number = 0
track?
Section titled “track?”number = 0
Returns
Section titled “Returns”boolean
advanceAndApply()
Section titled “advanceAndApply()”advanceAndApply(
instanceId,dt):void
Defined in: spine/SpineController.ts:275
The animation clock onto the bones’ LOCAL transforms — see spineBounds and the runtime’s ensurePose for why this is not the whole pose.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
number
Returns
Section titled “Returns”void
animationDuration()
Section titled “animationDuration()”animationDuration(
skeletonHandle,animation):number
Defined in: spine/SpineController.ts:285
Seconds; negative where this skeleton has no such animation.
Parameters
Section titled “Parameters”skeletonHandle
Section titled “skeletonHandle”number
animation
Section titled “animation”string
Returns
Section titled “Returns”number
clipBudget()
Section titled “clipBudget()”clipBudget(
instanceId):SpineClipBudget|null
Defined in: spine/SpineController.ts:246
What this instance’s clipping costs the engine in the pose it is in, as work rather than time: a coefficient measured on one machine and compiler stops being true, and the three quantities below do not.
null where the runtime cannot answer — 2.1 and 4.3 have no counted walk.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
Returns
Section titled “Returns”SpineClipBudget | null
collectEvents()
Section titled “collectEvents()”collectEvents(
instanceId):RawSpineEvent[]
Defined in: spine/SpineController.ts:394
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
Returns
Section titled “Returns”RawSpineEvent[]
createInstance()
Section titled “createInstance()”createInstance(
skeletonHandle):number
Defined in: spine/SpineController.ts:119
Parameters
Section titled “Parameters”skeletonHandle
Section titled “skeletonHandle”number
Returns
Section titled “Returns”number
destroyInstance()
Section titled “destroyInstance()”destroyInstance(
instanceId):void
Defined in: spine/SpineController.ts:123
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
Returns
Section titled “Returns”void
enableEvents()
Section titled “enableEvents()”enableEvents(
instanceId):void
Defined in: spine/SpineController.ts:390
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
Returns
Section titled “Returns”void
forEachMeshBatch()
Section titled “forEachMeshBatch()”forEachMeshBatch(
instanceId,cb,probe?):void
Defined in: spine/SpineController.ts:335
Iterate this instance’s mesh batches. The views point into wasm scratch and are valid only for the duration of each call, so a consumer copies straight into its own heap and nothing allocates a typed array per batch per frame.
The walk itself is shared with every other skeletal module (see skeletal/meshBatches) — the four readback entry points are packed the same way on the C++ side, so reading them differently per runtime would be two copies of one contract.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
MeshBatchVisitor
probe?
Section titled “probe?”SkeletalProbe
Returns
Section titled “Returns”void
getAnimations()
Section titled “getAnimations()”getAnimations(
instanceId):string[]
Defined in: spine/SpineController.ts:167
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
Returns
Section titled “Returns”string[]
getAtlasPageCount()
Section titled “getAtlasPageCount()”getAtlasPageCount(
handle):number
Defined in: spine/SpineController.ts:102
Parameters
Section titled “Parameters”handle
Section titled “handle”number
Returns
Section titled “Returns”number
getAtlasPageTextureName()
Section titled “getAtlasPageTextureName()”getAtlasPageTextureName(
handle,pageIndex):string
Defined in: spine/SpineController.ts:106
Parameters
Section titled “Parameters”handle
Section titled “handle”number
pageIndex
Section titled “pageIndex”number
Returns
Section titled “Returns”string
getBonePosition()
Section titled “getBonePosition()”getBonePosition(
instanceId,boneName):Vec2|null
Defined in: spine/SpineController.ts:187
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
boneName
Section titled “boneName”string
Returns
Section titled “Returns”Vec2 | null
getBoneRotation()
Section titled “getBoneRotation()”getBoneRotation(
instanceId,boneName):number
Defined in: spine/SpineController.ts:204
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
boneName
Section titled “boneName”string
Returns
Section titled “Returns”number
getBoneTree()
Section titled “getBoneTree()”getBoneTree(
instanceId):SkeletalBone[] |null
Defined in: spine/SpineController.ts:213
The skeleton as a tree in the pose the instance is in: each bone’s name, parent (-1 for a root), where it starts, the way it points in degrees and how long it is, in skeleton space. Null from a module built before the call existed.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
Returns
Section titled “Returns”SkeletalBone[] | null
getBounds()
Section titled “getBounds()”getBounds(
instanceId):object
Defined in: spine/SpineController.ts:306
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
Returns
Section titled “Returns”object
height
Section titled “height”height:
number
width:
number
x:
number
y:
number
getLastError()
Section titled “getLastError()”getLastError():
string
Defined in: spine/SpineController.ts:94
Returns
Section titled “Returns”string
getPathConstraintMix()
Section titled “getPathConstraintMix()”getPathConstraintMix(
instanceId,name):PathMixData|null
Defined in: spine/SpineController.ts:450
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
string
Returns
Section titled “Returns”PathMixData | null
getSkins()
Section titled “getSkins()”getSkins(
instanceId):string[]
Defined in: spine/SpineController.ts:177
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
Returns
Section titled “Returns”string[]
getTransformConstraintMix()
Section titled “getTransformConstraintMix()”getTransformConstraintMix(
instanceId,name):TransformMixData|null
Defined in: spine/SpineController.ts:435
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
string
Returns
Section titled “Returns”TransformMixData | null
listConstraints()
Section titled “listConstraints()”listConstraints(
instanceId):ConstraintList
Defined in: spine/SpineController.ts:426
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
Returns
Section titled “Returns”loadSkeleton()
Section titled “loadSkeleton()”loadSkeleton(
skelData,atlasText,isBinary):number
Defined in: spine/SpineController.ts:74
Parameters
Section titled “Parameters”skelData
Section titled “skelData”string | Uint8Array<ArrayBufferLike>
atlasText
Section titled “atlasText”string
isBinary
Section titled “isBinary”boolean
Returns
Section titled “Returns”number
materializeWorldPose()
Section titled “materializeWorldPose()”materializeWorldPose(
instanceId,dt):void
Defined in: spine/SpineController.ts:280
The world transforms the local pose implies.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
number
Returns
Section titled “Returns”void
play()
Section titled “play()”play(
instanceId,animation,loop?,track?):boolean
Defined in: spine/SpineController.ts:146
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
animation
Section titled “animation”string
boolean = true
track?
Section titled “track?”number = 0
Returns
Section titled “Returns”boolean
requiresContinuousWorldPose()
Section titled “requiresContinuousWorldPose()”requiresContinuousWorldPose(
skeletonHandle):boolean
Defined in: spine/SpineController.ts:290
Whether this skeleton’s world pose carries state and may not be deferred.
Parameters
Section titled “Parameters”skeletonHandle
Section titled “skeletonHandle”number
Returns
Section titled “Returns”boolean
setAtlasPageTexture()
Section titled “setAtlasPageTexture()”setAtlasPageTexture(
handle,pageIndex,textureId,width,height):void
Defined in: spine/SpineController.ts:110
Parameters
Section titled “Parameters”handle
Section titled “handle”number
pageIndex
Section titled “pageIndex”number
textureId
Section titled “textureId”number
number
height
Section titled “height”number
Returns
Section titled “Returns”void
setAttachment()
Section titled “setAttachment()”setAttachment(
instanceId,slotName,attachmentName):boolean
Defined in: spine/SpineController.ts:359
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
slotName
Section titled “slotName”string
attachmentName
Section titled “attachmentName”string
Returns
Section titled “Returns”boolean
setDefaultMix()
Section titled “setDefaultMix()”setDefaultMix(
skeletonHandle,duration):void
Defined in: spine/SpineController.ts:343
Parameters
Section titled “Parameters”skeletonHandle
Section titled “skeletonHandle”number
duration
Section titled “duration”number
Returns
Section titled “Returns”void
setIKTarget()
Section titled “setIKTarget()”setIKTarget(
instanceId,constraintName,targetX,targetY,mix):boolean
Defined in: spine/SpineController.ts:367
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
constraintName
Section titled “constraintName”string
targetX
Section titled “targetX”number
targetY
Section titled “targetY”number
number
Returns
Section titled “Returns”boolean
setMixDuration()
Section titled “setMixDuration()”setMixDuration(
skeletonHandle,fromAnim,toAnim,duration):void
Defined in: spine/SpineController.ts:347
Parameters
Section titled “Parameters”skeletonHandle
Section titled “skeletonHandle”number
fromAnim
Section titled “fromAnim”string
toAnim
Section titled “toAnim”string
duration
Section titled “duration”number
Returns
Section titled “Returns”void
setPathConstraintMix()
Section titled “setPathConstraintMix()”setPathConstraintMix(
instanceId,name,mix):boolean
Defined in: spine/SpineController.ts:460
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
string
Returns
Section titled “Returns”boolean
setSkeletonColor()
Section titled “setSkeletonColor()”setSkeletonColor(
instanceId,r,g,b,a):boolean
Defined in: spine/SpineController.ts:382
Whole-skeleton tint, multiplied into every vertex — backs SpineAnimation.color. Optional-chained: a spine wasm without this export (a realm still on an older module — the SDK can lead the wasm) degrades to a no-op instead of crashing.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
number
number
number
number
Returns
Section titled “Returns”boolean
setSkin()
Section titled “setSkin()”setSkin(
instanceId,skinName):void
Defined in: spine/SpineController.ts:155
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
skinName
Section titled “skinName”string
Returns
Section titled “Returns”void
setSlotColor()
Section titled “setSlotColor()”setSlotColor(
instanceId,slotName,r,g,b,a):boolean
Defined in: spine/SpineController.ts:375
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
slotName
Section titled “slotName”string
number
number
number
number
Returns
Section titled “Returns”boolean
setToSetupPose()
Section titled “setToSetupPose()”setToSetupPose(
instanceId):void
Defined in: spine/SpineController.ts:142
Back to where the skeleton’s data says it starts, every track cleared.
The one state a replay is reproducible from: play resets nothing, so a
bone the next animation does not key keeps whatever the last pose left it
at, and seeking twice to one time gives two poses.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
Returns
Section titled “Returns”void
setTrackAlpha()
Section titled “setTrackAlpha()”setTrackAlpha(
instanceId,track,alpha):void
Defined in: spine/SpineController.ts:351
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
number
number
Returns
Section titled “Returns”void
setTransformConstraintMix()
Section titled “setTransformConstraintMix()”setTransformConstraintMix(
instanceId,name,mix):boolean
Defined in: spine/SpineController.ts:445
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
string
Returns
Section titled “Returns”boolean
skeletonBounds()
Section titled “skeletonBounds()”skeletonBounds(
skeletonHandle):SpineAABB|null
Defined in: spine/SpineController.ts:296
What the skeleton was AUTHORED at, in its own space — no instance, no pose, and never an authority over culling. See spineBounds.
Parameters
Section titled “Parameters”skeletonHandle
Section titled “skeletonHandle”number
Returns
Section titled “Returns”SpineAABB | null
unloadSkeleton()
Section titled “unloadSkeleton()”unloadSkeleton(
handle):void
Defined in: spine/SpineController.ts:98
Parameters
Section titled “Parameters”handle
Section titled “handle”number
Returns
Section titled “Returns”void
update()
Section titled “update()”update(
instanceId,dt):void
Defined in: spine/SpineController.ts:159
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”number
number
Returns
Section titled “Returns”void