Omitting the parameter returns the current value (getter), whereas defining the parameter sets the value (setter) and returns the instance itself for easier chaining.
Version:
GreenSock Docs
Back to GSAP
Tween
Methods
.delay()
.duration()
.endTime()
.eventCallback()
.from()
.fromTo()
.invalidate()
.isActive()
.iteration()
.kill()
.pause()
.paused()
.play()
.progress()
.repeat()
.repeatDelay()
.restart()
.resume()
.reverse()
.reversed()
.seek()
.set()
.startTime()
.then()
.time()
.timeScale()
.to()
.totalDuration()
.totalProgress()
.totalTime()
.yoyo()
Tween
.repeat()
.repeat( value:Number ) : *
Gets or sets the number of times that the tween should repeat after its first iteration.
Parameters
value: Number
(default = 0) — Omitting the parameter returns the current value (getter), whereas defining the parameter sets the value (setter) and returns the instance itself for easier chaining.
Returns : *
Details
Gets or sets the number of times that the tween should repeat after its first iteration. For example, if repeat is 1, the tween will play a total of twice (the initial play plus 1 repeat). To repeat indefinitely, use -1. repeat should always be an integer.
To cause the repeats to alternate between forward and backward, set yoyo to true. To add a time gap between repeats, use repeatDelay. You can set the initial repeat value via the vars parameter, like: gsap.to(obj, {duration: 1, x: 100, repeat: 2});
This method serves as both a getter and setter. Omitting the parameter returns the current value (getter), whereas defining the parameter sets the value (setter) and returns the instance itself for easier chaining, like myTween.repeat(2).yoyo(true).play();
var progress = myTween.progress(); //gets current progressmyTween.progress( 0.25 ); //sets progress to one quarter finished