SpineManager
Defined in: spine/SpineManager.ts:43
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SpineManager(
coreModule,moduleFactories):SpineManager
Defined in: spine/SpineManager.ts:56
Parameters
Section titled “Parameters”coreModule
Section titled “coreModule”NonNullable<EngineApi>
Whichever engine core is present (see ecs/engineApi.ts).
moduleFactories
Section titled “moduleFactories”Map<SpineVersion, SpineModuleFactory>
Returns
Section titled “Returns”SpineManager
Accessors
Section titled “Accessors”observing
Section titled “observing”Get Signature
Section titled “Get Signature”get observing():
boolean
Defined in: spine/SpineManager.ts:190
Whether anything is counting.
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”boneTree()
Section titled “boneTree()”boneTree(
entity):SkeletalBoneTree|null
Defined in: spine/SpineManager.ts:243
The posed bones of this entity’s skeleton and how it places them; null if not loaded.
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”SkeletalBoneTree | null
boundEntities()
Section titled “boundEntities()”boundEntities():
Iterable<number>
Defined in: spine/SpineManager.ts:132
The entities that currently have a skeleton bound — what a per-frame pass over “everything spine draws” iterates, without asking the World.
Returns
Section titled “Returns”Iterable<number>
clipBudget()
Section titled “clipBudget()”clipBudget(
entity):SpineClipBudget|null
Defined in: spine/SpineManager.ts:230
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”SpineClipBudget | null
collectAllEvents()
Section titled “collectAllEvents()”collectAllEvents(
isActive?):object[]
Defined in: spine/SpineManager.ts:332
Parameters
Section titled “Parameters”isActive?
Section titled “isActive?”(entity) => boolean
Returns
Section titled “Returns”object[]
diagnostics()
Section titled “diagnostics()”diagnostics():
SpineSceneDiagnostics
Defined in: spine/SpineManager.ts:199
Why this scene’s spine costs what it does — the frame’s numbers joined to the per-asset reason each of them was paid. Derived on the spot from what the runtimes already know; see spineSceneDiagnostics.
Returns
Section titled “Returns”dispose()
Section titled “dispose()”dispose():
void
Defined in: spine/SpineManager.ts:147
Tear down every loaded runtime, freeing the native skeletons / atlases
each holds. Idempotent — clearing the maps makes a second call a no-op.
The ONE teardown door: shutdown() was a second name for this.
Returns
Section titled “Returns”void
enableEvents()
Section titled “enableEvents()”enableEvents(
entity):void
Defined in: spine/SpineManager.ts:327
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”void
getAnimations()
Section titled “getAnimations()”getAnimations(
entity):string[]
Defined in: spine/SpineManager.ts:234
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”string[]
getBounds()
Section titled “getBounds()”getBounds(
entity): {height:number;width:number;x:number;y:number; } |null
Defined in: spine/SpineManager.ts:218
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”{ height: number; width: number; x: number; y: number; } | null
getEntityVersion()
Section titled “getEntityVersion()”getEntityVersion(
entity):SpineVersion|undefined
Defined in: spine/SpineManager.ts:157
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”SpineVersion | undefined
getPathConstraintMix()
Section titled “getPathConstraintMix()”getPathConstraintMix(
entity,name):PathMixData|null
Defined in: spine/SpineManager.ts:298
Parameters
Section titled “Parameters”entity
Section titled “entity”number
string
Returns
Section titled “Returns”PathMixData | null
getSkins()
Section titled “getSkins()”getSkins(
entity):string[]
Defined in: spine/SpineManager.ts:238
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”string[]
getTransformConstraintMix()
Section titled “getTransformConstraintMix()”getTransformConstraintMix(
entity,name):TransformMixData|null
Defined in: spine/SpineManager.ts:286
Parameters
Section titled “Parameters”entity
Section titled “entity”number
string
Returns
Section titled “Returns”TransformMixData | null
hasInstance()
Section titled “hasInstance()”hasInstance(
entity):boolean
Defined in: spine/SpineManager.ts:343
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”boolean
hasRuntime()
Section titled “hasRuntime()”hasRuntime(
version):boolean
Defined in: spine/SpineManager.ts:161
Parameters
Section titled “Parameters”version
Section titled “version”Returns
Section titled “Returns”boolean
listConstraints()
Section titled “listConstraints()”listConstraints(
entity):ConstraintList|null
Defined in: spine/SpineManager.ts:280
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”ConstraintList | null
loadEntity()
Section titled “loadEntity()”loadEntity(
entity,era,_registry):Promise<SpineVersion|null>
Defined in: spine/SpineManager.ts:76
Parameters
Section titled “Parameters”entity
Section titled “entity”number
SpineEraBinding
The prepared era and the right to keep it alive — indivisible, so a runtime can never be given one generation’s id with another’s claim.
_registry
Section titled “_registry”CppRegistry
Returns
Section titled “Returns”Promise<SpineVersion | null>
observe()
Section titled “observe()”observe(
on):void
Defined in: spine/SpineManager.ts:169
Start or stop reporting what frames cost, on every runtime this app has and every one it loads later. Off by default.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
observedBounds()
Section titled “observedBounds()”observedBounds(
entity,sampleStep?):SpineCullingEnvelope|null
Defined in: spine/SpineManager.ts:226
What a scan of this entity’s skeleton saw — an OBSERVATION, for authoring to propose a culling contract from. Never an authority: see spineBounds.
Parameters
Section titled “Parameters”entity
Section titled “entity”number
sampleStep?
Section titled “sampleStep?”number
Returns
Section titled “Returns”SpineCullingEnvelope | null
openPreview()
Section titled “openPreview()”openPreview(
era):Promise<SpinePreviewInstance|null>
Defined in: spine/SpineManager.ts:179
Open a skeleton for an editor to pose itself, outside this manager’s
bindings: it is never advanced by updateAnimations and never drawn by
submitMeshes. Null when the era’s version has no runtime here.
Parameters
Section titled “Parameters”SpineEraBinding
Returns
Section titled “Returns”Promise<SpinePreviewInstance | null>
removeEntity()
Section titled “removeEntity()”removeEntity(
entity):void
Defined in: spine/SpineManager.ts:136
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”void
setAnimation()
Section titled “setAnimation()”setAnimation(
entity,animation,loop):void
Defined in: spine/SpineManager.ts:203
Parameters
Section titled “Parameters”entity
Section titled “entity”number
animation
Section titled “animation”string
boolean
Returns
Section titled “Returns”void
setAttachment()
Section titled “setAttachment()”setAttachment(
entity,slotName,attachmentName):boolean
Defined in: spine/SpineManager.ts:262
Parameters
Section titled “Parameters”entity
Section titled “entity”number
slotName
Section titled “slotName”string
attachmentName
Section titled “attachmentName”string
Returns
Section titled “Returns”boolean
setDefaultMix()
Section titled “setDefaultMix()”setDefaultMix(
entity,duration):void
Defined in: spine/SpineManager.ts:247
Parameters
Section titled “Parameters”entity
Section titled “entity”number
duration
Section titled “duration”number
Returns
Section titled “Returns”void
setEnabled()
Section titled “setEnabled()”setEnabled(
entity,enabled):void
Defined in: spine/SpineManager.ts:319
Take an entity out of the frame, or put it back: a disabled entity keeps its
instance but stops posing and drawing. Distinct from playing: false, which
freezes the pose and keeps showing it.
Also driven by SpineAnimation.enabled — the plugin carries that field
across on its edges (skeletal/enableSync), so writing the component wins at
the moment it is written and this call holds between such writes.
Parameters
Section titled “Parameters”entity
Section titled “entity”number
enabled
Section titled “enabled”boolean
Returns
Section titled “Returns”void
setEntityProps()
Section titled “setEntityProps()”setEntityProps(
entity,props):void
Defined in: spine/SpineManager.ts:211
Parameters
Section titled “Parameters”entity
Section titled “entity”number
color?
Section titled “color?”{ a: number; b: number; g: number; r: number; }
color.a
Section titled “color.a”number
color.b
Section titled “color.b”number
color.g
Section titled “color.g”number
color.r
Section titled “color.r”number
flipX?
Section titled “flipX?”boolean
flipY?
Section titled “flipY?”boolean
layer?
Section titled “layer?”number
playing?
Section titled “playing?”boolean
skeletonScale?
Section titled “skeletonScale?”number
timeScale?
Section titled “timeScale?”number
Returns
Section titled “Returns”void
setIKTarget()
Section titled “setIKTarget()”setIKTarget(
entity,constraintName,targetX,targetY,mix):boolean
Defined in: spine/SpineManager.ts:268
Parameters
Section titled “Parameters”entity
Section titled “entity”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(
entity,fromAnim,toAnim,duration):void
Defined in: spine/SpineManager.ts:252
Parameters
Section titled “Parameters”entity
Section titled “entity”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(
entity,name,mix):boolean
Defined in: spine/SpineManager.ts:304
Parameters
Section titled “Parameters”entity
Section titled “entity”number
string
Returns
Section titled “Returns”boolean
setSkin()
Section titled “setSkin()”setSkin(
entity,skin):void
Defined in: spine/SpineManager.ts:207
Parameters
Section titled “Parameters”entity
Section titled “entity”number
string
Returns
Section titled “Returns”void
setSlotColor()
Section titled “setSlotColor()”setSlotColor(
entity,slotName,r,g,b,a):boolean
Defined in: spine/SpineManager.ts:274
Parameters
Section titled “Parameters”entity
Section titled “entity”number
slotName
Section titled “slotName”string
number
number
number
number
Returns
Section titled “Returns”boolean
setTrackAlpha()
Section titled “setTrackAlpha()”setTrackAlpha(
entity,track,alpha):void
Defined in: spine/SpineManager.ts:257
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
number
Returns
Section titled “Returns”void
setTransformConstraintMix()
Section titled “setTransformConstraintMix()”setTransformConstraintMix(
entity,name,mix):boolean
Defined in: spine/SpineManager.ts:292
Parameters
Section titled “Parameters”entity
Section titled “entity”number
string
Returns
Section titled “Returns”boolean
submitMeshes()
Section titled “submitMeshes()”submitMeshes(
registry,materialOf?,isActive?):void
Defined in: spine/SpineManager.ts:124
Skip extraction for entities the activity predicate excludes.
Parameters
Section titled “Parameters”registry
Section titled “registry”CppRegistry
materialOf?
Section titled “materialOf?”SkeletalMaterialOf
isActive?
Section titled “isActive?”(entity) => boolean
Returns
Section titled “Returns”void
updateAnimations()
Section titled “updateAnimations()”updateAnimations(
dt,isActive?):void
Defined in: spine/SpineManager.ts:117
Freeze inactive entities without changing their manual enable state.
Parameters
Section titled “Parameters”number
isActive?
Section titled “isActive?”(entity) => boolean
Returns
Section titled “Returns”void
detectVersion()
Section titled “detectVersion()”
staticdetectVersion(data):SpineVersion|null
Defined in: spine/SpineManager.ts:65
Parameters
Section titled “Parameters”Uint8Array
Returns
Section titled “Returns”SpineVersion | null
detectVersionJson()
Section titled “detectVersionJson()”
staticdetectVersionJson(json):SpineVersion|null
Defined in: spine/SpineManager.ts:71
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”SpineVersion | null