## Phaser. TweenData

#### new TweenData(parent)

  A Phaser.Tween contains at least one TweenData object. It contains all of the tween data values, such as the
  starting and ending values, the ease function, interpolation and duration. The Tween acts as a timeline manager for
  TweenData objects and can contain multiple TweenData objects.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `parent` | Phaser.Tween | The Tween that owns this TweenData object.

  Source - tween/TweenData.js, line 16

### Members

#### <static, constant> COMPLETE :number

  Source - tween/TweenData.js, line 179

#### <static, constant> LOOPED :number

  Source - tween/TweenData.js, line 173

#### <static, constant> PENDING :number

  Source - tween/TweenData.js, line 161

#### <static, constant> RUNNING :number

  Source - tween/TweenData.js, line 167

#### delay :number

  The amount to delay by until the Tween starts (in ms). Only applies to the start, use repeatDelay to handle repeats.

  Source - tween/TweenData.js, line 113

#### dt :number

  Current time value.

  Source - tween/TweenData.js, line 118

#### duration :number

  The duration of the tween in ms.

  Default Value:
    - 1000
  Source - tween/TweenData.js, line 56

#### easingFunction :function

  The easing function used for the Tween.

  Default Value:
    - Phaser.Easing.Default
  Source - tween/TweenData.js, line 129

#### game :Phaser.Game

  A reference to the currently running Game.

  Source - tween/TweenData.js, line 26

#### inReverse :boolean

  When a Tween is yoyoing this value holds if it's currently playing forwards (false) or in reverse (true).

  Source - tween/TweenData.js, line 107

#### interpolate :boolean

  True if the Tween will use interpolation (i.e. is an Array to Array tween)

  Source - tween/TweenData.js, line 90

#### interpolationContext :object

  The interpolation function context used for the Tween.

  Default Value:
    - Phaser.Math
  Source - tween/TweenData.js, line 141

#### interpolationFunction :function

  The interpolation function used for the Tween.

  Default Value:
    - Phaser.Math.linearInterpolation
  Source - tween/TweenData.js, line 135

#### isFrom :boolean

  Is this a from tween or a to tween?

  Source - tween/TweenData.js, line 153

#### isRunning :boolean

  If the tween is running this is set to `true`. Unless Phaser.Tween a TweenData that is waiting for a delay to expire is not considered as running.

  Source - tween/TweenData.js, line 147

#### parent :Phaser.Tween

  The Tween which owns this TweenData.

  Source - tween/TweenData.js, line 21

#### <readonly> percent :number

  A value between 0 and 1 that represents how far through the duration this tween is.

  Source - tween/TweenData.js, line 62

#### repeatCounter :number

  If the Tween is set to repeat this contains the current repeat count.

  Source - tween/TweenData.js, line 73

#### repeatDelay :number

  The amount of time in ms between repeats of this tween.

  Source - tween/TweenData.js, line 78

#### <readonly> repeatTotal :number

  The total number of times this Tween will repeat.

  Source - tween/TweenData.js, line 84

#### startTime :number

  The time the Tween started or null if it hasn't yet started.

  Source - tween/TweenData.js, line 123

#### <readonly> value :number

  The current calculated value.

  Source - tween/TweenData.js, line 68

#### yoyo :boolean

  True if the Tween is set to yoyo, otherwise false.

  Source - tween/TweenData.js, line 96

#### yoyoDelay :number

  The amount of time in ms between yoyos of this tween.

  Source - tween/TweenData.js, line 101

### Methods

#### from(properties, duration, ease, delay, repeat, yoyo) → {Phaser.TweenData}

  Sets this tween to be a `from` tween on the properties given. A `from` tween sets the target to the destination value and tweens to its current value.
  For example a Sprite with an `x` coordinate of 100 tweened from `x` 500 would be set to `x` 500 and then tweened to `x` 100 by giving a properties object of `{ x: 500 }`.

  ##### Parameters:

  Name | Type | Argument | Default | Description
  --- | --- | --- | --- | ---
  `properties` | object |  |  | The properties you want to tween, such as `Sprite.x` or `Sound.volume`. Given as a JavaScript object.
  `duration` | number | <optional> | 1000 | Duration of this tween in ms.
  `ease` | function | <optional> | null | Easing function. If not set it will default to Phaser.Easing.Default, which is Phaser.Easing.Linear.None by default but can be over-ridden at will.
  `delay` | number | <optional> | 0 | Delay before this tween will start, defaults to 0 (no delay). Value given is in ms.
  `repeat` | number | <optional> | 0 | Should the tween automatically restart once complete? If you want it to run forever set as -1. This ignores any chained tweens.
  `yoyo` | boolean | <optional> | false | A tween that yoyos will reverse itself and play backwards automatically. A yoyo'd tween doesn't fire the Tween.onComplete event, so listen for Tween.onLoop instead.

  ##### Returns:

  Phaser.TweenData -

  This Tween object.

  Source - tween/TweenData.js, line 211

#### generateData(frameRate) → {array}

  This will generate an array populated with the tweened object values from start to end.
  It works by running the tween simulation at the given frame rate based on the values set-up in Tween.to and Tween.from.
  Just one play through of the tween data is returned, including yoyo if set.

  ##### Parameters:

  Name | Type | Argument | Default | Description
  --- | --- | --- | --- | ---
  `frameRate` | number | <optional> | 60 | The speed in frames per second that the data should be generated at. The higher the value, the larger the array it creates.

  ##### Returns:

  array -

  An array of tweened values.

  Source - tween/TweenData.js, line 411

#### start() → {Phaser.TweenData}

  Starts the Tween running.

  ##### Returns:

  Phaser.TweenData -

  This Tween object.

  Source - tween/TweenData.js, line 239

#### to(properties, duration, ease, delay, repeat, yoyo) → {Phaser.TweenData}

  Sets this tween to be a `to` tween on the properties given. A `to` tween starts at the current value and tweens to the destination value given.
  For example a Sprite with an `x` coordinate of 100 could be tweened to `x` 200 by giving a properties object of `{ x: 200 }`.

  ##### Parameters:

  Name | Type | Argument | Default | Description
  --- | --- | --- | --- | ---
  `properties` | object |  |  | The properties you want to tween, such as `Sprite.x` or `Sound.volume`. Given as a JavaScript object.
  `duration` | number | <optional> | 1000 | Duration of this tween in ms.
  `ease` | function | <optional> | null | Easing function. If not set it will default to Phaser.Easing.Default, which is Phaser.Easing.Linear.None by default but can be over-ridden at will.
  `delay` | number | <optional> | 0 | Delay before this tween will start, defaults to 0 (no delay). Value given is in ms.
  `repeat` | number | <optional> | 0 | Should the tween automatically restart once complete? If you want it to run forever set as -1. This ignores any chained tweens.
  `yoyo` | boolean | <optional> | false | A tween that yoyos will reverse itself and play backwards automatically. A yoyo'd tween doesn't fire the Tween.onComplete event, so listen for Tween.onLoop instead.

  ##### Returns:

  Phaser.TweenData -

  This Tween object.

  Source - tween/TweenData.js, line 183

#### <internal> update(time) → {number}

  Updates this Tween. This is called automatically by Phaser.Tween.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `time` | number | A timestamp passed in by the Tween parent.

  ##### Returns:

  number -

  The current status of this Tween. One of the Phaser.TweenData constants: PENDING, RUNNING, LOOPED or COMPLETE.

  Internal:
    - This member is internal (protected) and may be modified or removed in the future.
  Source - tween/TweenData.js, line 340