Play Commands

Tween Play Commands

Once a Tween is created in Twillex, it can be saved and played any number of times. (The exception is if you created it with the "delete:true" parameter, which deletes the Tween when it reaches the end of play.)

Playing Tweens is meant to be as easy as possible to work with. Tweens start at the beginning, of course. From there, you can manipulate them with the following method calls:

play()

Play() will continue a Tween where it left off from motion before. When it reaches the end, it will stop. It is safe to call play() multiple times in a row. It will simply keep playing. Note that a second call to play() does not stop the Tween or reset it.

When the Tween reaches the end, it will stop and call onComplete if you defined one. If the Tween was already at its end when you called play(), it will immediately stop (and call onComplete*).

If a Tween is playing in reverse (see below), it will play towards the beginning and stop when it hits the beginning (including calling onComplete*). This should work out naturally in regular use.

stop()

Stop() will stop a Tween where it is in motion. If you stop() a Tween that is already stopped, nothing will happen. Note that stopping a Tween does not call a supplied onComplete, not even if the Tween was already at the end.

reverse()

Reverse() plays a Tween backwards. That is, play from the current location to the beginning. Calling this over and over will not switch between forward and backward. In this way, you can always call reverse() if you want to be sure it is playing backwards.

forward()

Forward() plays a Tween forward from the current location to the end. Calling this over and over will not switch between forward and backward. In this way, you can always call forward() if you want to be sure it is playing forward.

rewind()

Rewind() sets a Tween back to its beginning. If it was playing it will continue to play, or if it was stopped it will stay stopped. Note that if the Tween was playing backwards, then rewind() will set it to its ending, but this should work out naturally.

fforward()

Fforward() Set a Tween to its ending. If it was stopped it will stay stopped. If it was playing it will continue to play, but now we're at the end so it will immediately stop and call any provided onComplete. Note that if the Tween was playing backwards, then fforward() will set it to the beginning, but this should work out naturally.

reset()

Reset() will reconfigure the Tween as if it were being created in the current object state (location, color, etc). Tweens change an object from where it was when the Tween was created, to where it will be, based on the Tween's parameters. When you rewind() a Tween it changes the object's state to what it was when the Tween was created. Reset() reconfigures the Tween as if it were created in the object's current state, even if it's moved since the Tween was first created.

Note that the Tween will be built with relative or absolute values, depending on which are set for the Tween. For instance, if we were moving 10 units in x, we will move another 10 in x from here. But if we were moving to position 0 in x, we will again move to position 0 in x from here.

isPlaying()

isReplaying() tests whether a Tween is playing or stopped.