Omitting the parameter returns the current value (getter), whereas defining the parameter sets the value (setter) and returns the instance itself for easier chaining.
GreenSock Docs
Back to Docs Home (v2)
TweenLite
Constructor
Properties
Methods
.delay()
TweenLite.delayedCall()
.duration()
.endTime()
.eventCallback()
TweenLite.from()
TweenLite.fromTo()
TweenLite.getTweensOf()
.invalidate()
.isActive()
.kill()
TweenLite.killDelayedCallsTo()
TweenLite.killTweensOf()
TweenLite.lagSmoothing()
.pause()
.paused()
.play()
.progress()
TweenLite.render()
.restart()
.resume()
.reverse()
.reversed()
.seek()
TweenLite.set()
.startTime()
.time()
.timeScale()
TweenLite.to()
.totalDuration()
.totalProgress()
.totalTime()
TweenLite
.progress()
.progress( value:Number, suppressEvents:Boolean ) : *
Gets or sets the animations's progress which is a value between 0 and 1 indicating the position of the virtual playhead (excluding repeats) where 0 is at the beginning, 0.5 is at the halfway point, and 1 is at the end (complete).
Parameters
value: Number
(default = NaN) — Omitting the parameter returns the current value (getter), whereas defining the parameter sets the value (setter) and returns the instance itself for easier chaining.
suppressEvents: Boolean
(default = false) — If true, no events or callbacks will be triggered when the playhead moves to the new position.
Returns : *
Details
Gets or sets the animations's progress which is a value between 0 and 1 indicating the position of the virtual playhead (excluding repeats) where 0 is at the beginning, 0.5 is at the halfway point, and 1 is at the end (complete). If the animation has a non-zero repeat defined (only available in TweenMax and TimelineMax), progress() and totalProgress() will be different because progress() doesn't include the repeat orrepeatDelay whereas totalProgress() does. For example, if a TimelineMax instance is set to repeat once, at the end of the first cycletotalProgress() would only be 0.5 whereas progress() would be 1. If you watched both properties over the course of the entire animation, you'd see progress() go from 0 to 1 twice (once for each cycle) in the same time it takes the totalProgress() to go from 0 to 1 once.
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 myAnimation.progress(0.5).play();
var progress = myAnimation.progress(); //gets current progress
myAnimation.progress(0.25); //sets progress to one quarter finished