Cocos Creator API

1.3.0

Cocos Creator is a highly customizable game development tool that utilizes the power of cocos2d-x.

AnimationState

The AnimationState gives full control over animation playback process. In most cases the Animation Component is sufficient and easier to use. Use the AnimationState if you need full control.

clip AnimationClip readOnly

The clip that is being played by this animation state.

name String readOnly

The name of the playing animation.

curves AnimCurve

The curves list.

delay Number

The start delay which represents the number of seconds from an animation's start time to the start of the active interval.

repeatCount Number

The animation's iteration count property.

A real number greater than or equal to zero (including positive infinity) representing the number of times to repeat the animation node.

Values less than zero and NaN values are treated as the value 1.0 for the purpose of timing model calculations.

duration Number readOnly

The iteration duration of this animation in seconds. (length)

speed Number

The animation's playback speed. 1 is normal playback speed.

wrapMode WrapMode

Wrapping mode of the playing animation. Notice : dynamic change wrapMode will reset time and repeatCount property

time Number

The current time of this animation in seconds.

isPlaying Boolean readOnly

Is playing or paused in play mode?

isPaused Boolean readOnly

Is currently paused? This can be true even if in edit mode(isPlaying == false).

There are no properties that match your current filter settings. You can change your filter settings in the index section on this page. index

AnimationState
(
  • clip
  • [name ]
)
AnimationState

clip AnimationClip
name optional String

update
(
  • deltaTime
)
private

deltaTime Number

onPlay ( ) private

onPause ( ) private

onResume ( ) private

onStop ( ) private

onError
(
  • errorCode
)
private

errorCode string

play ( )

Play this animation.

stop ( )

Stop this animation.

pause ( )

Pause this animation.

resume ( )

Resume this animation.

step ( )

Perform a single frame step.

There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. index