Interface ITween

ITween defines an interface which forms the basis for an object that supports a gradual transition between 2 values.

Hierarchy

ITween

Implemented by

Index

Accessors

Methods

then toJSON update

Accessors

from

get from(): number
The value to start the tween from.

Returns number
- Defined in Tweens.ts:13

to

get to(): number
The value to end the tween at.

Returns number
- Defined in Tweens.ts:16

Methods

then

then(tween: ITween, weight?: number): ITween
Allows for tweens to be chained one after another.
Parameters
- tween: ITween
  
  The next tween to follow after the current one.
- Optional weight: number
  
  Weighting to determine how much of the tweening time that the new tween gets.
Returns ITween
- Defined in Tweens.ts:29

toJSON

toJSON(): any
Used by the library for the custom serialization of tween objects

Returns any
- Defined in Tweens.ts:32

update

update(percent: number): number
Accepts a percent value and returns a corresponding value somewhere between the from and to values.
Parameters
- percent: number
  
  Expects a value ranging from 0 to 1.
Returns number
- Defined in Tweens.ts:22

Generated using TypeDoc