DragonBonesManager
Defined in: dragonbones/DragonBonesManager.ts:55
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DragonBonesManager(
controller):DragonBonesManager
Defined in: dragonbones/DragonBonesManager.ts:61
Parameters
Section titled “Parameters”controller
Section titled “controller”Returns
Section titled “Returns”DragonBonesManager
Accessors
Section titled “Accessors”controller
Section titled “controller”Get Signature
Section titled “Get Signature”get controller():
DragonBonesModuleController
Defined in: dragonbones/DragonBonesManager.ts:65
Returns
Section titled “Returns”Methods
Section titled “Methods”addEntity()
Section titled “addEntity()”addEntity(
entity,skeletonHandle,options):boolean
Defined in: dragonbones/DragonBonesManager.ts:101
Attach an armature to entity. Replaces whatever it had.
Parameters
Section titled “Parameters”entity
Section titled “entity”number
skeletonHandle
Section titled “skeletonHandle”number
options
Section titled “options”Returns
Section titled “Returns”boolean
boundEntities()
Section titled “boundEntities()”boundEntities():
Iterable<number>
Defined in: dragonbones/DragonBonesManager.ts:144
The entities that currently have an armature bound — what a per-frame pass over “everything DragonBones draws” iterates, without asking the World.
Returns
Section titled “Returns”Iterable<number>
dispose()
Section titled “dispose()”dispose():
void
Defined in: dragonbones/DragonBonesManager.ts:247
Drop every instance and skeleton. Idempotent, so a second call is a no-op.
Returns
Section titled “Returns”void
fadeIn()
Section titled “fadeIn()”fadeIn(
entity,animation,fadeSeconds,loop?):boolean
Defined in: dragonbones/DragonBonesManager.ts:194
Crossfade in, which is where DragonBones puts what Spine keeps in a table.
Parameters
Section titled “Parameters”entity
Section titled “entity”number
animation
Section titled “animation”string
fadeSeconds
Section titled “fadeSeconds”number
boolean = true
Returns
Section titled “Returns”boolean
getAnimations()
Section titled “getAnimations()”getAnimations(
entity):string[]
Defined in: dragonbones/DragonBonesManager.ts:211
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”string[]
getArmatures()
Section titled “getArmatures()”getArmatures(
skeletonHandle):string[]
Defined in: dragonbones/DragonBonesManager.ts:94
Parameters
Section titled “Parameters”skeletonHandle
Section titled “skeletonHandle”number
Returns
Section titled “Returns”string[]
getBounds()
Section titled “getBounds()”getBounds(
entity):SkeletalBounds|null
Defined in: dragonbones/DragonBonesManager.ts:216
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”SkeletalBounds | null
hasInstance()
Section titled “hasInstance()”hasInstance(
entity):boolean
Defined in: dragonbones/DragonBonesManager.ts:138
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”boolean
loadSkeleton()
Section titled “loadSkeleton()”loadSkeleton(
skeletonData,atlasJson,assetKey?):number
Defined in: dragonbones/DragonBonesManager.ts:75
Parse a file once per assetKey, or every time when none is given.
Returns -1 on failure, with the reason on the controller.
Parameters
Section titled “Parameters”skeletonData
Section titled “skeletonData”string | Uint8Array<ArrayBufferLike>
atlasJson
Section titled “atlasJson”string
assetKey?
Section titled “assetKey?”string
Returns
Section titled “Returns”number
play()
Section titled “play()”play(
entity,animation,loop?):boolean
Defined in: dragonbones/DragonBonesManager.ts:188
Parameters
Section titled “Parameters”entity
Section titled “entity”number
animation
Section titled “animation”string
boolean = true
Returns
Section titled “Returns”boolean
removeEntity()
Section titled “removeEntity()”removeEntity(
entity):void
Defined in: dragonbones/DragonBonesManager.ts:129
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”void
setAtlasTexture()
Section titled “setAtlasTexture()”setAtlasTexture(
skeletonHandle,textureId):void
Defined in: dragonbones/DragonBonesManager.ts:90
Bind the uploaded atlas page; safe after instances exist.
Parameters
Section titled “Parameters”skeletonHandle
Section titled “skeletonHandle”number
textureId
Section titled “textureId”number
Returns
Section titled “Returns”void
setColor()
Section titled “setColor()”setColor(
entity,r,g,b,a):void
Defined in: dragonbones/DragonBonesManager.ts:181
Tint the whole armature. Multiplied onto each slot’s authored colour, so opaque white is not “no tint applied” but “the tint that changes nothing” — which is why clearing the field in the editor restores the original rather than leaving the last colour stuck.
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
number
number
number
Returns
Section titled “Returns”void
setEnabled()
Section titled “setEnabled()”setEnabled(
entity,enabled):void
Defined in: dragonbones/DragonBonesManager.ts:155
A disabled entity keeps its instance but stops advancing and drawing.
Also driven by DragonBonesAnimation.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: dragonbones/DragonBonesManager.ts:160
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Partial<Pick<EntityInfo, "layer" | "playing" | "flipX" | "flipY" | "skeletonScale">> & object
Returns
Section titled “Returns”void
setTimeScale()
Section titled “setTimeScale()”setTimeScale(
entity,scale):void
Defined in: dragonbones/DragonBonesManager.ts:204
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
Returns
Section titled “Returns”void
stop()
Section titled “stop()”stop(
entity,animation?):void
Defined in: dragonbones/DragonBonesManager.ts:199
Parameters
Section titled “Parameters”entity
Section titled “entity”number
animation?
Section titled “animation?”string = ''
Returns
Section titled “Returns”void
submitMeshes()
Section titled “submitMeshes()”submitMeshes(
core,registry):void
Defined in: dragonbones/DragonBonesManager.ts:233
Parameters
Section titled “Parameters”SkeletalSubmitCore
registry
Section titled “registry”unknown
Returns
Section titled “Returns”void
updateAnimations()
Section titled “updateAnimations()”updateAnimations(
dt):void
Defined in: dragonbones/DragonBonesManager.ts:223
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void