API / TimelineState

Class: abstract TimelineState

Defined in: animation/BaseTimelineState.ts:32

Internal

Extends

• BaseObject

Extended by

• TweenTimelineState
• ActionTimelineState
• ZOrderTimelineState
• SlotDisplayTimelineState

Constructors

Constructor

new TimelineState(): TimelineState;

Returns

TimelineState

Inherited from

BaseObject.constructor

Properties

currentPlayTimes

currentPlayTimes: number;

Defined in: animation/BaseTimelineState.ts:38

---

currentTime

currentTime: number;

Defined in: animation/BaseTimelineState.ts:39

---

dirty

dirty: boolean;

Defined in: animation/BaseTimelineState.ts:33

---

hashCode

readonly hashCode: number;

Defined in: core/BaseObject.ts:156

A unique identification number assigned to the object.

Inherited from

BaseObject.hashCode

---

playState

playState: number;

Defined in: animation/BaseTimelineState.ts:37

-1: start, 0: play, 1: complete;

---

target

target: BaseObject;

Defined in: animation/BaseTimelineState.ts:40

Methods

blend()

blend(_isDirty: boolean): void;

Defined in: animation/BaseTimelineState.ts:231

Parameters

Parameter	Type
_isDirty	boolean

Returns

void

---

fadeOut()

fadeOut(): void;

Defined in: animation/BaseTimelineState.ts:198

Returns

void

---

init()

init(
   armature: Armature, 
   animationState: AnimationState, 
   timelineData: TimelineData): void;

Defined in: animation/BaseTimelineState.ts:168

Parameters

Parameter	Type
armature	Armature
animationState	AnimationState
timelineData	TimelineData

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

---

update()

update(passedTime: number): void;

Defined in: animation/BaseTimelineState.ts:202

Parameters

Parameter	Type
passedTime	number

Returns

void

---

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: core/BaseObject.ts:56

Returns

string

Inherited from

BaseObject.toString