API / AnimationData

Class: AnimationData

Defined in: model/AnimationData.ts:34

The animation data.

Extends

• BaseObject

Constructors

Constructor

new AnimationData(): AnimationData;

Returns

AnimationData

Inherited from

BaseObject.constructor

Properties

duration

duration: number;

Defined in: model/AnimationData.ts:80

The duration of the animation. (In seconds)

---

fadeInTime

fadeInTime: number;

Defined in: model/AnimationData.ts:92

The fade in time of the animation. (In seconds)

---

frameCount

frameCount: number;

Defined in: model/AnimationData.ts:64

The frame count of the animation.

---

frameFloatOffset

frameFloatOffset: number;

Defined in: model/AnimationData.ts:47

Internal

• FrameFloatArray.

---

frameIntOffset

frameIntOffset: number;

Defined in: model/AnimationData.ts:42

Internal

• FrameIntArray.

---

frameOffset

frameOffset: number;

Defined in: model/AnimationData.ts:52

Internal

• FrameArray.

---

hashCode

readonly hashCode: number;

Defined in: core/BaseObject.ts:156

A unique identification number assigned to the object.

Inherited from

BaseObject.hashCode

---

name

name: string;

Defined in: model/AnimationData.ts:104

The animation name.

---

playTimes

playTimes: number;

Defined in: model/AnimationData.ts:72

The play times of the animation. [0: Loop play, [1~N]: Play N times]

Methods

cacheFrames()

cacheFrames(frameRate: number): void;

Defined in: model/AnimationData.ts:220

Internal

Parameters

Parameter	Type
frameRate	number

Returns

void

---

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/AnimationData.ts:35

Returns

string

Overrides

BaseObject.toString