Returns a TweenDataConfig object that describes the tween data for a unique property of a unique target. A single Tween consists of multiple TweenDatas, depending on how many properties are being changed by the Tween.
This is an internal function used by the TweenBuilder and should not be accessed directly, instead, Tweens should be created using the GameObjectFactory or GameObjectCreator.
| name | type | description |
|---|---|---|
| target | any |
The target to tween. |
| index | number |
The target index within the Tween targets array. |
| key | string |
The property of the target to tween. |
| getEnd | function |
What the property will be at the END of the Tween. |
| getStart | function |
What the property will be at the START of the Tween. |
| getActive | function |
If not null, is invoked immediately as soon as the TweenData is running, and is set on the target property. |
| ease | function |
The ease function this tween uses. |
| delay | number |
Time in ms/frames before tween will start. |
| duration | number |
Duration of the tween in ms/frames. |
| yoyo | boolean |
Determines whether the tween should return back to its start value after hold has expired. |
| hold | number |
Time in ms/frames the tween will pause before repeating or returning to its starting value if yoyo is set to true. |
| repeat | number |
Number of times to repeat the tween. The tween will always run once regardless, so a repeat value of '1' will play the tween twice. |
| repeatDelay | number |
Time in ms/frames before the repeat will start. |
| flipX | boolean |
Should toggleFlipX be called when yoyo or repeat happens? |
| flipY | boolean |
Should toggleFlipY be called when yoyo or repeat happens? |
The config object describing this TweenData.