API Docs for: 1.4.0
Show:

Kiwi.Animations.Tween Class

Defined in: src\animations\tweens\Tween.ts:10
Module: Tweens
Parent Module: Animations

Manages the tweening of properties/values on a single object. A Tween is the animation of a number between an initially value to and final value (that you specify). Note: When using a Tween you need to make sure that the Tween has been added to a TweenManager. You can either do this by creating the Tween via the Manager or alternatively using the 'add' method on the TweenManager. Otherwise the tween will not work.

Based on tween.js by sole. Converted to TypeScript and integrated into Kiwi. https://github.com/sole/tween.js

Constructor

Kiwi.Animations.Tween

(
  • object
  • game
)
Kiwi.Animations.Tween

Defined in src\animations\tweens\Tween.ts:10

Parameters:

  • object Any

    The object that this tween is taking affect on.

  • game Kiwi.Game

    The game that this tween is for.

Returns:

Kiwi.Animations.Tween:

This tween.

Methods

chain

(
  • tween
)
Kiwi.Animations.Tween public

Defined in src\animations\tweens\Tween.ts:434

Adds another tween that should start playing once tween has completed.

Parameters:

Returns:

Kiwi.Animations.Tween:

delay

(
  • amount
)
Kiwi.Animations.Tween public

Defined in src\animations\tweens\Tween.ts:391

Sets the amount of delay that the tween is to have before it starts playing.

Parameters:

  • amount Number

    The amount of time to delay the tween by.

Returns:

Kiwi.Animations.Tween:

easing

(
  • easing
)
Kiwi.Animations.Tween public

Defined in src\animations\tweens\Tween.ts:405

Sets the easing method that is to be used when animating this tween.

Parameters:

  • easing Function

    The easing function to use.

Returns:

Kiwi.Animations.Tween:

interpolation

(
  • interpolation
)
Kiwi.Animations.Tween public

Defined in src\animations\tweens\Tween.ts:419

[REQUIRES DESCRIPTION]

Parameters:

  • interpolation Any

Returns:

Kiwi.Animations.Tween:

objType

() String public

Defined in src\animations\tweens\Tween.ts:51

The type of object that this is.

Returns:

String:

"Tween"

onComplete

(
  • callback
  • context
)
public

Defined in src\animations\tweens\Tween.ts:479

Defines a method that is to be called when this tween is finished.

Parameters:

  • callback Function

    The method that is to be executed.

  • context Any

    The context the method is to have when called.

onStart

(
  • callback
  • context
)
Kiwi.Animations.Tween public

Defined in src\animations\tweens\Tween.ts:448

Adds a function that is to be executed when the tween start playing.

Parameters:

  • callback Function

    The function that is to be executed on tween start.

  • context Any

    The context that function is to have when called.

Returns:

Kiwi.Animations.Tween:

onUpdate

(
  • callback
  • context
)
public

Defined in src\animations\tweens\Tween.ts:464

Adds a function that is to be executed when this tween updates while it is playing.

Parameters:

  • callback Function

    The method that is to be executed.

  • context Any

    The context the method is to have when called.

setParent

(
  • value
)
public

Defined in src\animations\tweens\Tween.ts:378

Sets the game and the manager of this tween.

Parameters:

start

() public

Defined in src\animations\tweens\Tween.ts:308

Gets the initial values for the properties that it is to animate and starts the tween process.

stop

() public

Defined in src\animations\tweens\Tween.ts:360

Stops the Tween from running and removes it from the manager.

to

(
  • properties
  • [duration=1000]
  • [ease=null]
  • [autoStart=false]
)
Kiwi.Animations.Tween public

Defined in src\animations\tweens\Tween.ts:276

Sets up the various properties that define this tween. The ending position/properties for this tween, how long the tween should go for, easing method to use and if should start right way.

Parameters:

  • properties Object

    The ending location of the properties that you want to tween.

  • [duration=1000] Number optional

    The duration of the tween.

  • [ease=null] Any optional

    The easing method to be used. If not specifed then this will default to LINEAR.

  • [autoStart=false] Boolean optional

    If the tween should start right away.

Returns:

Kiwi.Animations.Tween:

update

(
  • time
)
Boolean public

Defined in src\animations\tweens\Tween.ts:495

The update loop is executed every frame whilst the tween is running.

Parameters:

  • time Number

Returns:

Boolean:

Whether the Tween is still running

Properties

_chainedTweens

Tween private

Defined in src\animations\tweens\Tween.ts:186

An array containing all of the tweens that are to be played when this one finishes.

_delayTime

Number private

Defined in src\animations\tweens\Tween.ts:152

The amount of time to delay the tween by. In Milliseconds.

_duration

Number private

Defined in src\animations\tweens\Tween.ts:144

The duration of the tween, in milliseconds.

_easingFunction

Function private

Defined in src\animations\tweens\Tween.ts:168

The easing function that is to be used while tweening.

Default: Kiwi.Tweens.Easing.Linear.None

_game

Kiwi.Game private

Defined in src\animations\tweens\Tween.ts:61

The game that this tween belongs to.

_interpolationFunction

Function private

Defined in src\animations\tweens\Tween.ts:177

[NEEDS DESCRIPTION]

Default: Kiwi.Utils.Interpolation.Linear

_manager

Kiwi.Animations.Tweens.TweenManager private

Defined in src\animations\tweens\Tween.ts:69

The manager that this tween belongs to.

_object

Any private

Defined in src\animations\tweens\Tween.ts:92

The object that this tween is affecting.

_onCompleteCallback

Function private

Defined in src\animations\tweens\Tween.ts:239

A method to be called when the tween finish's tweening.

Default: null

_onCompleteContext

Any private

Defined in src\animations\tweens\Tween.ts:258

The context that the onCompleteCallback should have when called.

Default: null

_onStartCallback

Function private

Defined in src\animations\tweens\Tween.ts:194

The method that is to be called when the tween starts playing.

Default: null

_onStartCallbackFired

Boolean private

Defined in src\animations\tweens\Tween.ts:212

A boolean indicating if the starting callback has been called or not.

Default: false

_onStartContext

Any private

Defined in src\animations\tweens\Tween.ts:203

The context that the _onStartCallback method is to be called in.

Default: null

_onUpdateCallback

Function private

Defined in src\animations\tweens\Tween.ts:221

A callback method that will be called each time the tween updates.

Default: null

_onUpdateContext

Any private

Defined in src\animations\tweens\Tween.ts:230

The context that the update callback has when called.

Default: null

_startTime

Number private

Defined in src\animations\tweens\Tween.ts:160

The time at which the tween started.

_valuesEnd

Object private

Defined in src\animations\tweens\Tween.ts:136

The end values of the properties that the tween is animating.

_valuesStart

Object private

Defined in src\animations\tweens\Tween.ts:128

The starting values of the properties that the tween is animating.

isRunning.

Boolean public

Defined in src\animations\tweens\Tween.ts:267

An indication of whether or not this tween is currently running.

Default: false

manager

Kiwi.Animations.Tweens.TweenManager private

Defined in src\animations\tweens\Tween.ts:77

Available since 1.2.0

The manager that this tween belongs to.

object

Any public

Defined in src\animations\tweens\Tween.ts:100

The object that this tween is affecting. If you change this, it will continue to tween, but any properties that are not on the new object will be discarded from the tween.