Tween Class

Module: cc

Tween provide a simple and flexible way to create action. Tween's api is more flexible than cc.Action:

• Support creating an action sequence in chained api.
• Support animate any objects' any properties, not limited to node's properties. By contrast, cc.Action needs to create a new action class to support new node property.
• Support working with cc.Action.
• Support easing and progress function.

Examples

cc.tween(node)
  .to(1, {scale: 2, position: cc.v3(100, 100, 100)})
  .call(() => { console.log('This is a callback'); })
  .by(1, {scale: 3, position: cc.v3(200, 200, 200)}, {easing: 'sineOutIn'})
  .start(cc.find('Canvas/cocos'));

Index

Methods

• constructor
• stopAll Stop all tweens
• stopAllByTag Stop all tweens by tag
• stopAllByTarget Stop all tweens by target
• then Insert an action or tween to this sequence
• target Set tween target
• start Start this tween
• stop Stop this tween
• tag Sets tween tag
• clone Clone a tween
• union Integrate all previous actions to an action.
• bezierTo Sets target's position property according to the bezier curve.
• bezierBy Sets target's position property according to the bezier curve.
• flipX Flips target's scaleX
• flipY Flips target's scaleY
• blink Blinks target by set target's opacity property
• to Add an action which calculate with absolute value
• by Add an action which calculate with relative value
• set Directly set target properties
• delay Add an delay action
• call Add an callback action
• hide Add an hide action
• show Add an show action
• removeSelf Add an removeSelf action
• sequence Add an sequence action
• parallel Add an parallel action
• repeat Add an repeat action.
• repeatForever Add an repeat forever action.
• reverseTime Add an reverse time action.

Details

Methods

constructor

Parameters

• target Object

stopAll

Stop all tweens

stopAllByTag

Stop all tweens by tag

Parameters

• tag number

stopAllByTarget

Stop all tweens by target

Parameters

• target Object

then

Insert an action or tween to this sequence

Parameters

• other Action | Tween

target

Set tween target

Parameters

• target Object

start

Start this tween

stop

Stop this tween

tag

Sets tween tag

Parameters

• tag number

clone

Clone a tween

Parameters

• target Object

union

Integrate all previous actions to an action.

bezierTo

Sets target's position property according to the bezier curve.

Parameters

• duration number
• c1 cc.Vec2
• c2 cc.Vec2
• to cc.Vec2

bezierBy

Sets target's position property according to the bezier curve.

Parameters

• duration number
• c1 cc.Vec2
• c2 cc.Vec2
• to cc.Vec2

flipX

Flips target's scaleX

flipY

Flips target's scaleY

blink

Blinks target by set target's opacity property

Parameters

• duration number
• times number
• opts Object
  • progress Function
  • easing Function | String

to

Add an action which calculate with absolute value

Parameters

• duration Number
• props Object {scale: 2, position: cc.v3(100, 100, 100)}
• opts Object
  • progress Function
  • easing Function | String

by

Add an action which calculate with relative value

Parameters

• duration Number
• props Object {scale: 2, position: cc.v3(100, 100, 100)}
• opts Object
  • progress Function
  • easing Function | String

set

Directly set target properties

Parameters

• props Object

delay

Add an delay action

Parameters

• duration Number

call

Add an callback action

Parameters

• callback Function
• selectTarget object

hide

Add an hide action

show

Add an show action

removeSelf

Add an removeSelf action

sequence

Add an sequence action

Parameters

• action Action | Tween
• actions Action | Tween

parallel

Add an parallel action

Parameters

• action Action | Tween
• actions Action | Tween

repeat

Add an repeat action. This action will integrate before actions to a sequence action as their parameters.

Parameters

• repeatTimes Number
• action Action | Tween

repeatForever

Add an repeat forever action. This action will integrate before actions to a sequence action as their parameters.

Parameters

• action Action | Tween

reverseTime

Add an reverse time action. This action will integrate before actions to a sequence action as their parameters.

Parameters

• action Action | Tween