Phaser API Documentation

  Version: 

Member of: Phaser.Tweens.Tween

updateTo(key, value, [startToCurrent])

Description:

Updates the 'end' value of the given property across all matching targets, as long as this Tween is currently playing (either forwards or backwards).

Calling this does not adjust the duration of the Tween, or the current progress.

You can optionally tell it to set the 'start' value to be the current value.

If this Tween is in any other state other than playing then calling this method has no effect.

Additionally, if the Tween repeats, is reset, or is seeked, it will revert to the original starting and ending values.

Parameters:

name type arguments Default description
key string

The property to set the new value for. You cannot update the 'texture' property via this method.

value number

The new value of the property.

startToCurrent boolean <optional> false

Should this change set the start value to be the current value?

Returns:
Description:

This Tween instance.

Since: 3.0.0