A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.
TypeScript 2d-game-engine3d3d-game-engineandroidcppecsgame-editorgame-enginegamedeviostypescriptwebassemblywebglwebgpuwechat-minigame
API surface — esengine/dragonbones
Symbols: 0 public · 0 beta · 18 experimental · 0 deprecated
DragonBones — const @experimental
ResourceDef<DragonBonesManager | null>
DragonBonesArmatureNames — interface @experimental
animations: string[]
name: string
DragonBonesAssetInfo — interface @experimental
atlasJson: string
skeletonData: string | Uint8Array<ArrayBufferLike>
textureId: number
DragonBonesEntityOptions — interface @experimental
animation: string | undefined
armature: string
assetKey: string | undefined
flipX: boolean | undefined
flipY: boolean | undefined
layer: number | undefined
loop: boolean | undefined
skeletonScale: number | undefined
DragonBonesManager — class @experimental
@internal discardUnboundSkeleton: (assetKey: string) => void
addEntity: (entity: Entity, skeletonHandle: number, options: DragonBonesEntityOptions) => boolean
boneTree: (entity: Entity) => SkeletalBoneTree | null
boundEntities: () => Iterable<Entity>
controller: DragonBonesModuleController
dispose: () => void
fadeIn: (entity: Entity, animation: string, fadeSeconds: number, loop?: boolean) => boolean
getAnimations: (entity: Entity) => string[]
getArmatures: (skeletonHandle: number) => string[]
getBounds: (entity: Entity) => SkeletalBounds | null
hasInstance: (entity: Entity) => boolean
loadSkeleton: (skeletonData: Uint8Array | string, atlasJson: string, assetKey?: string) => number
play: (entity: Entity, animation: string, loop?: boolean) => boolean
removeEntity: (entity: Entity) => void
setAtlasTexture: (skeletonHandle: number, textureId: number) => void
setColor: (entity: Entity, r: number, g: number, b: number, a: number) => void
setEnabled: (entity: Entity, enabled: boolean) => void
setEntityProps: (entity: Entity, props: Partial<Pick<EntityInfo, "flipX" | "flipY" | "layer" | "playing" | "skeletonScale">> & { timeScale?: number; color?: { r: number; g: number; b: number; a: number; }; }) => void
setTimeScale: (entity: Entity, scale: number) => void
stop: (entity: Entity, animation?: string) => void
submitMeshes: (core: SkeletalSubmitCore, registry: unknown, materialOf?: SkeletalMaterialOf, isActive?: (entity: Entity) => boolean) => void
updateAnimations: (dt: number, isActive?: (entity: Entity) => boolean) => void
static new (controller: DragonBonesModuleController): DragonBonesManager
static prototype: DragonBonesManager
DragonBonesModuleController — class @experimental
createInstance: (skeletonHandle: number, armatureName: string) => number
destroyInstance: (instanceId: number) => void
fadeIn: (instanceId: number, animation: string, fadeSeconds: number, loop?: boolean) => boolean
forEachMeshBatch: (instanceId: number, cb: MeshBatchVisitor) => void
getAnimations: (instanceId: number) => string[]
getArmatures: (handle: number) => string[]
getAtlasImageName: (handle: number) => string
getBoneTree: (instanceId: number) => SkeletalBone[] | null
getBounds: (instanceId: number) => SkeletalBounds
getLastError: () => string
loadSkeleton: (skeletonData: Uint8Array | string, atlasJson: string) => number
play: (instanceId: number, animation: string, loop?: boolean) => boolean
runtimeVersion: () => number
setAtlasTexture: (handle: number, textureId: number) => void
setColor: (instanceId: number, r: number, g: number, b: number, a: number) => void
setTimeScale: (instanceId: number, scale: number) => void
stop: (instanceId: number, animation?: string) => void
unloadSkeleton: (handle: number) => void
update: (instanceId: number, dt: number) => void
static new (raw: DragonBonesWasmModule, api: DragonBonesWrappedAPI): DragonBonesModuleController
static prototype: DragonBonesModuleController
DragonBonesModuleFactory — type @experimental
(options?: { wasmBinary?: Uint8Array }) => Promise<DragonBonesWasmModule>
DragonBonesPlugin — class @experimental
acquire: () => Promise<DragonBonesManager | null>
build: (app: App) => void
cleanup: () => void
manager: DragonBonesManager | null
name: string
static new (manager?: DragonBonesManager): DragonBonesPlugin
static prototype: DragonBonesPlugin
DragonBonesWasmModule — interface @experimental
HEAP32: Int32Array<ArrayBufferLike>
HEAPF32: Float32Array<ArrayBufferLike>
HEAPU32: Uint32Array<ArrayBufferLike>
HEAPU8: Uint8Array<ArrayBufferLike>
_free: (ptr: number) => void
_malloc: (size: number) => number
cwrap: (name: string, ret: string | null, sig: string[]) => (...args: unknown[]) => unknown
DragonBonesWrappedAPI — interface @experimental
createInstance: (handle: number, armatureName: string) => number
destroyInstance: (instanceId: number) => void
fadeInAnimation: (instanceId: number, name: string, fadeSeconds: number, playTimes: number) => number
getAnimations: (instanceId: number) => string
getArmatures: (handle: number) => string
getAtlasImageName: (handle: number) => string
getBonePoses: ((instanceId: number, outPtr: number, capacity: number) => number) | undefined
getBones: ((instanceId: number) => string) | undefined
getBounds: (instanceId: number, xPtr: number, yPtr: number, wPtr: number, hPtr: number) => void
getLastError: () => string
getMeshBatchCount: (instanceId: number) => number
getMeshBatchData: (instanceId: number, batchIndex: number, verticesPtr: number, indicesPtr: number, textureIdPtr: number, blendModePtr: number) => void
getMeshBatchIndexCount: (instanceId: number, batchIndex: number) => number
getMeshBatchVertexCount: (instanceId: number, batchIndex: number) => number
loadSkeleton: (skeletonPtr: number, skeletonLen: number, atlasPtr: number, atlasLen: number) => number
playAnimation: (instanceId: number, name: string, playTimes: number) => number
runtimeVersion: () => number
setAtlasTexture: (handle: number, textureId: number) => void
setColor: (instanceId: number, r: number, g: number, b: number, a: number) => void
setTimeScale: (instanceId: number, scale: number) => void
stopAnimation: (instanceId: number, name: string) => void
unloadSkeleton: (handle: number) => void
update: (instanceId: number, dt: number) => void
RuntimeAssetSource — interface @experimental
backend: Backend
compressedTexture: ((path: string) => Promise<Uint8Array | "pending" | null>) | undefined
decodePixels: (path: string, flip: boolean, maxEdge?: number) => Promise<{ width: number; height: number; pixels: Uint8Array; }>
listAssetPaths: (() => string[]) | undefined
resolveAddress: ((ref: string) => string | null) | undefined
resolveRef: ((ref: string) => string) | undefined
spineCulling: ((skeleton: string, atlas: string) => { x: number; y: number; width: number; height: number; } | undefined) | undefined
textureImportSettings: ((ref: string) => ParsedTextureImportSettings | undefined) | undefined
applyDragonBonesEntities — function @experimental
(opts: { manager: DragonBonesManager; sceneData: SceneData; entityMap: Map<number, Entity>; assetInfo: Map<string, DragonBonesAssetInfo>; }): void
dragonBonesEntityProps — function @experimental
(d: Record<string, unknown>): { skeletonScale: number; flipX: boolean; flipY: boolean; layer: number; timeScale: number; playing: boolean; color: { r: number; g: number; b: number; a: number; }; }
dragonBonesPlugin — const @experimental
() => DragonBonesPlugin
loadDragonBonesAssets — function @experimental
(module: ESEngineModule | null, source: RuntimeAssetSource, pairs: ReadonlyArray<{ skeleton: string; atlas: string; }>, transcoderProvider?: TranscoderProvider): Promise<Map<string, DragonBonesAssetInfo>>
loadDragonBonesSceneEntities — function @experimental
(opts: { module: ESEngineModule | null; source: RuntimeAssetSource; manager: DragonBonesManager; sceneData: SceneData; entityMap: Map<number, Entity>; transcoderProvider?: TranscoderProvider; }): Promise<void>
parseDragonBonesNames — function @experimental
(source: string | object): DragonBonesArmatureNames[]
wrapDragonBonesModule — function @experimental
(raw: DragonBonesWasmModule): DragonBonesWrappedAPI