API / DragonBonesData

Class: DragonBonesData

Defined in: model/DragonBonesData.ts:38

The DragonBones data. A DragonBones data contains multiple armature data.

Extends

• BaseObject

Constructors

Constructor

new DragonBonesData(): DragonBonesData;

Returns

DragonBonesData

Inherited from

BaseObject.constructor

Properties

armatureNames

readonly armatureNames: string[] = [];

Defined in: model/DragonBonesData.ts:91

All armature data names.

---

binary

binary: ArrayBuffer;

Defined in: model/DragonBonesData.ts:99

Internal

---

cachedFrames

readonly cachedFrames: number[] = [];

Defined in: model/DragonBonesData.ts:83

Internal

---

colorArray

colorArray: Int16Array<ArrayBuffer> | Uint16Array<ArrayBuffer>;

Defined in: model/DragonBonesData.ts:127

Internal

---

floatArray

floatArray: Float32Array;

Defined in: model/DragonBonesData.ts:107

Internal

---

frameArray

frameArray: Int16Array;

Defined in: model/DragonBonesData.ts:119

Internal

---

frameFloatArray

frameFloatArray: Float32Array;

Defined in: model/DragonBonesData.ts:115

Internal

---

frameIndices

readonly frameIndices: number[] = [];

Defined in: model/DragonBonesData.ts:79

Internal

---

frameIntArray

frameIntArray: Int16Array;

Defined in: model/DragonBonesData.ts:111

Internal

---

frameRate

frameRate: number;

Defined in: model/DragonBonesData.ts:53

The animation frame rate.

---

hashCode

readonly hashCode: number;

Defined in: core/BaseObject.ts:156

A unique identification number assigned to the object.

Inherited from

BaseObject.hashCode

---

intArray

intArray: Int16Array;

Defined in: model/DragonBonesData.ts:103

Internal

---

name

name: string;

Defined in: model/DragonBonesData.ts:71

The DragonBones data name. The name is consistent with the DragonBones project name.

---

timelineArray

timelineArray: Uint16Array;

Defined in: model/DragonBonesData.ts:123

Internal

---

version

version: string;

Defined in: model/DragonBonesData.ts:61

The data version.

Methods

addArmature()

addArmature(value: ArmatureData): void;

Defined in: model/DragonBonesData.ts:165

Internal

Parameters

Parameter	Type
value	ArmatureData

Returns

void

---

getArmature()

getArmature(armatureName: string): ArmatureData;

Defined in: model/DragonBonesData.ts:185

Get a specific armature data.

Parameters

Parameter	Type	Description
armatureName	string	The armature data name.

Returns

ArmatureData

---

returnToPool()

returnToPool(): void;

Defined in: core/BaseObject.ts:167

Clear the object and return it back to object pool。

Returns

void

Inherited from

BaseObject.returnToPool

---

borrowObject()

static borrowObject<T>(objectConstructor: () => T): T;

Defined in: core/BaseObject.ts:136

Get an instance of the specify class from object pool.

Type Parameters

Type Parameter
T extends BaseObject

Parameters

Parameter	Type	Description
objectConstructor	() => T	The specify class.

Returns

T

Inherited from

BaseObject.borrowObject

---

clearPool()

static clearPool(objectConstructor: typeof BaseObject): void;

Defined in: core/BaseObject.ts:111

Clear the cached instances of a specify object pool.

Parameters

Parameter	Type	Default value	Description
objectConstructor	typeof BaseObject	null	Specify class. (Clear all cached instances if not set)

Returns

void

Inherited from

BaseObject.clearPool

---

setMaxCount()

static setMaxCount(objectConstructor: typeof BaseObject, maxCount: number): void;

Defined in: core/BaseObject.ts:72

Set the maximum cache count of the specify object pool.

Parameters

Parameter	Type	Description
objectConstructor	typeof BaseObject	The specify class. (Set all object pools max cache count if not set)
maxCount	number	Max count.

Returns

void

Inherited from

BaseObject.setMaxCount

---

toString()

static toString(): string;

Defined in: model/DragonBonesData.ts:39

Returns

string

Overrides

BaseObject.toString