Class Tween<T>

Tween provide a simple and flexible way to action, It's transplanted from cocos creator。

param
example: tween(this.node) .to(1, {scale: new Vec3(2, 2, 2), position: new Vec3(5, 5, 5)}) .call(() => { console.log('This is a callback'); }) .by(1, {scale: new Vec3(-1, -1, -1), position: new Vec3(-5, -5, -5)}, {easing: 'sineOutIn'}) .start()

Type parameters

T

Hierarchy

Tween

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

newTween(target?: T | null): Tween

- Defined in cocos/tween/tween.ts:66
Parameters
- Optional target: T | null
Returns Tween

Properties

Private _actions

_actions: Action[] = []

Private _finalAction

_finalAction: Action | null = null

Private _tag

_tag: number = Action.TAG_INVALID

Private _target

_target: T | null = null

Static Private Readonly _tmp_args

_tmp_args: Tween<any>[] | Action[] = []

Methods

Private destroy

_destroy(): void

- Defined in cocos/tween/tween.ts:424
Returns void

Private union

_union(): Action

- Defined in cocos/tween/tween.ts:412
Returns Action

by

by(duration: number, props: ConstructorType<T>, opts?: ITweenOption): Tween<T>

- Defined in cocos/tween/tween.ts:197
Add an action which calculate with relative value.

method

by

Parameters
- duration: number
  
  缓动时间，单位为秒
- props: ConstructorType<T>
  
  缓动的属性列表
- Optional opts: ITweenOption
Returns Tween<T>

call

call(callback: Function): Tween<T>

- Defined in cocos/tween/tween.ts:244
Add an callback action.

method

call

Parameters
- callback: Function
Returns Tween<T>

clone

clone(target: T): Tween<T>

- Defined in cocos/tween/tween.ts:146
Clone a tween.

Parameters
- target: T
Returns Tween<T>

delay

delay(duration: number): Tween<T>

- Defined in cocos/tween/tween.ts:229
Add an delay action.

method

delay

Parameters
- duration: number
Returns Tween<T>

hide

hide(): Tween<T>

- Defined in cocos/tween/tween.ts:354
Add an hide action, only for node target.

Returns Tween<T>

parallel

parallel(...args: Tween<T>[]): Tween<T>

- Defined in cocos/tween/tween.ts:268
Add an parallel action.

Parameters
- Rest ...args: Tween<T>[]
Returns Tween<T>

removeSelf

removeSelf(): Tween<T>

- Defined in cocos/tween/tween.ts:378
Add an removeSelf action, only for node target.

Returns Tween<T>

repeat

repeat(repeatTimes: number, embedTween?: Tween<T>): Tween<T>

- Defined in cocos/tween/tween.ts:283
Add an repeat action. This action will integrate before actions to a sequence action as their parameters.

Parameters
- repeatTimes: number
  
  重复次数
- Optional embedTween: Tween<T>
  
  可选，嵌入 Tween
Returns Tween<T>

repeatForever

repeatForever(embedTween?: Tween<T>): Tween<T>

- Defined in cocos/tween/tween.ts:311
Add an repeat forever action. This action will integrate before actions to a sequence action as their parameters.

method

repeatForever

Parameters
- Optional embedTween: Tween<T>
  
  可选，嵌入 Tween
Returns Tween<T>

reverseTime

reverseTime(embedTween?: Tween<T>): Tween<T>

- Defined in cocos/tween/tween.ts:334
Add an reverse time action. This action will integrate before actions to a sequence action as their parameters.

method

reverseTime

Parameters
- Optional embedTween: Tween<T>
  
  可选，嵌入 Tween
Returns Tween<T>

sequence

sequence(...args: Tween<T>[]): Tween<T>

- Defined in cocos/tween/tween.ts:256
Add an sequence action.

Parameters
- Rest ...args: Tween<T>[]
Returns Tween<T>

set

set(props: ConstructorType<T>): Tween<T>

- Defined in cocos/tween/tween.ts:214
Directly set target properties.

method

set

Parameters
- props: ConstructorType<T>
Returns Tween<T>

show

show(): Tween<T>

- Defined in cocos/tween/tween.ts:366
Add an show action, only for node target.

Returns Tween<T>

start

start(): Tween<T>

- Defined in cocos/tween/tween.ts:113
Start this tween.

Returns Tween<T>

stop

stop(): Tween<T>

- Defined in cocos/tween/tween.ts:133
Stop this tween.

Returns Tween<T>

tag

tag(tag: number): this

- Defined in cocos/tween/tween.ts:76
Sets tween tag

Parameters
- tag: number
Returns this

target

target(target: T): Tween<T | undefined>

- Defined in cocos/tween/tween.ts:102
Sets tween target.

Parameters
- target: T
Returns Tween<T | undefined>

then

then(other: Tween<T>): Tween<T>

- Defined in cocos/tween/tween.ts:87
Insert an action or tween to this sequence.

Parameters
- other: Tween<T>
Returns Tween<T>

to

to(duration: number, props: ConstructorType<T>, opts?: ITweenOption): Tween<T>

- Defined in cocos/tween/tween.ts:176
Add an action which calculate with absolute value.

method

to

Parameters
- duration: number
  
  缓动时间，单位为秒
- props: ConstructorType<T>
  
  缓动的属性列表
- Optional opts: ITweenOption
Returns Tween<T>

union

union(): Tween<T>

- Defined in cocos/tween/tween.ts:157
Integrate all previous actions to an action.

Returns Tween<T>

Static Private wrappedParallel

wrappedParallel(...args: Action[] | Tween<any>[]): FiniteTimeAction

- Defined in cocos/tween/tween.ts:443
Parameters
- Rest ...args: Action[] | Tween<any>[]
Returns FiniteTimeAction

Static Private wrappedSequence

wrappedSequence(...args: Action[] | Tween<any>[]): ActionInterval

- Defined in cocos/tween/tween.ts:430
Parameters
- Rest ...args: Action[] | Tween<any>[]
Returns ActionInterval

Static stopAll

stopAll(): void

- Defined in cocos/tween/tween.ts:390
Stop all tweens

Returns void

Static stopAllByTag

stopAllByTag(tag: number, target?: undefined | object): void

- Defined in cocos/tween/tween.ts:399
Stop all tweens by tag

Parameters
- tag: number
- Optional target: undefined | object
Returns void

Static stopAllByTarget

stopAllByTarget(target?: undefined | object): void

- Defined in cocos/tween/tween.ts:408
Stop all tweens by target

Parameters
- Optional target: undefined | object
Returns void

Generated using TypeDoc