ModuleBackend
Defined in: spine/ModuleBackend.ts:24
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ModuleBackend(
controller):ModuleBackend
Defined in: spine/ModuleBackend.ts:34
Parameters
Section titled “Parameters”controller
Section titled “controller”Returns
Section titled “Returns”ModuleBackend
Accessors
Section titled “Accessors”controller
Section titled “controller”Get Signature
Section titled “Get Signature”get controller():
SpineModuleController
Defined in: spine/ModuleBackend.ts:38
Returns
Section titled “Returns”entityCount
Section titled “entityCount”Get Signature
Section titled “Get Signature”get entityCount():
number
Defined in: spine/ModuleBackend.ts:42
Returns
Section titled “Returns”number
Methods
Section titled “Methods”collectAllEvents()
Section titled “collectAllEvents()”collectAllEvents():
object[]
Defined in: spine/ModuleBackend.ts:215
Returns
Section titled “Returns”object[]
enableEvents()
Section titled “enableEvents()”enableEvents(
entity):void
Defined in: spine/ModuleBackend.ts:210
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”void
extractAndSubmitMeshes()
Section titled “extractAndSubmitMeshes()”extractAndSubmitMeshes(
core,registry):void
Defined in: spine/ModuleBackend.ts:237
Parameters
Section titled “Parameters”NonNullable<EngineApi>
whichever engine core is present (see ecs/engineApi.ts) — the batches cross through its heap, which is wasm linear memory on the web and the host arena on a device.
registry
Section titled “registry”Returns
Section titled “Returns”void
getAnimations()
Section titled “getAnimations()”getAnimations(
entity):string[]
Defined in: spine/ModuleBackend.ts:123
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/ModuleBackend.ts:117
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”{ height: number; width: number; x: number; y: number; } | null
getPathConstraintMix()
Section titled “getPathConstraintMix()”getPathConstraintMix(
entity,name):PathMixData|null
Defined in: spine/ModuleBackend.ts:190
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/ModuleBackend.ts:129
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/ModuleBackend.ts:178
Parameters
Section titled “Parameters”entity
Section titled “entity”number
string
Returns
Section titled “Returns”TransformMixData | null
listConstraints()
Section titled “listConstraints()”listConstraints(
entity):ConstraintList|null
Defined in: spine/ModuleBackend.ts:172
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”ConstraintList | null
loadEntity()
Section titled “loadEntity()”loadEntity(
entity,skelData,atlasText,textures,isBinary,assetKey?):boolean
Defined in: spine/ModuleBackend.ts:46
Parameters
Section titled “Parameters”entity
Section titled “entity”number
skelData
Section titled “skelData”string | Uint8Array<ArrayBufferLike>
atlasText
Section titled “atlasText”string
textures
Section titled “textures”Map<string, { glId: number; h: number; w: number; }>
isBinary
Section titled “isBinary”boolean
assetKey?
Section titled “assetKey?”string
Returns
Section titled “Returns”boolean
removeEntity()
Section titled “removeEntity()”removeEntity(
entity):void
Defined in: spine/ModuleBackend.ts:264
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/ModuleBackend.ts:107
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/ModuleBackend.ts:154
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/ModuleBackend.ts:139
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/ModuleBackend.ts:202
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/ModuleBackend.ts:90
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/ModuleBackend.ts:160
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/ModuleBackend.ts:144
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/ModuleBackend.ts:196
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/ModuleBackend.ts:112
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/ModuleBackend.ts:166
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/ModuleBackend.ts:149
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/ModuleBackend.ts:184
Parameters
Section titled “Parameters”entity
Section titled “entity”number
string
Returns
Section titled “Returns”boolean
shutdown()
Section titled “shutdown()”shutdown():
void
Defined in: spine/ModuleBackend.ts:290
Returns
Section titled “Returns”void
updateAll()
Section titled “updateAll()”updateAll(
dt):void
Defined in: spine/ModuleBackend.ts:226
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void