Skip to content

API / ActionTimelineState

Class: ActionTimelineState

Defined in: animation/TimelineState.ts:35

Internal

Extends

Constructors

Constructor

ts
new ActionTimelineState(): ActionTimelineState;

Returns

ActionTimelineState

Inherited from

TimelineState.constructor

Properties

currentPlayTimes

ts
currentPlayTimes: number;

Defined in: animation/BaseTimelineState.ts:38

Inherited from

TimelineState.currentPlayTimes


currentTime

ts
currentTime: number;

Defined in: animation/BaseTimelineState.ts:39

Inherited from

TimelineState.currentTime


dirty

ts
dirty: boolean;

Defined in: animation/BaseTimelineState.ts:33

Inherited from

TimelineState.dirty


hashCode

ts
readonly hashCode: number;

Defined in: core/BaseObject.ts:156

A unique identification number assigned to the object.

Inherited from

TimelineState.hashCode


playState

ts
playState: number;

Defined in: animation/BaseTimelineState.ts:37

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

Inherited from

TimelineState.playState


target

ts
target: BaseObject;

Defined in: animation/BaseTimelineState.ts:40

Inherited from

TimelineState.target

Methods

blend()

ts
blend(_isDirty: boolean): void;

Defined in: animation/BaseTimelineState.ts:231

Parameters

ParameterType
_isDirtyboolean

Returns

void

Inherited from

TimelineState.blend


fadeOut()

ts
fadeOut(): void;

Defined in: animation/BaseTimelineState.ts:198

Returns

void

Inherited from

TimelineState.fadeOut


init()

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

Defined in: animation/BaseTimelineState.ts:168

Parameters

ParameterType
armatureArmature
animationStateAnimationState
timelineDataTimelineData

Returns

void

Inherited from

TimelineState.init


returnToPool()

ts
returnToPool(): void;

Defined in: core/BaseObject.ts:167

Clear the object and return it back to object pool。

Returns

void

Inherited from

TimelineState.returnToPool


setCurrentTime()

ts
setCurrentTime(value: number): void;

Defined in: animation/TimelineState.ts:269

Parameters

ParameterType
valuenumber

Returns

void


update()

ts
update(passedTime: number): void;

Defined in: animation/TimelineState.ts:77

Parameters

ParameterType
passedTimenumber

Returns

void

Overrides

TimelineState.update


borrowObject()

ts
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

ParameterTypeDescription
objectConstructor() => TThe specify class.

Returns

T

Inherited from

TimelineState.borrowObject


clearPool()

ts
static clearPool(objectConstructor: typeof BaseObject): void;

Defined in: core/BaseObject.ts:111

Clear the cached instances of a specify object pool.

Parameters

ParameterTypeDefault valueDescription
objectConstructortypeof BaseObjectnullSpecify class. (Clear all cached instances if not set)

Returns

void

Inherited from

TimelineState.clearPool


setMaxCount()

ts
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

ParameterTypeDescription
objectConstructortypeof BaseObjectThe specify class. (Set all object pools max cache count if not set)
maxCountnumberMax count.

Returns

void

Inherited from

TimelineState.setMaxCount


toString()

ts
static toString(): string;

Defined in: animation/TimelineState.ts:36

Returns

string

Overrides

TimelineState.toString

Released under the MIT License.