Packagecom.greensock.core
Classpublic class SimpleTimeline
InheritanceSimpleTimeline Inheritance TweenCore
SubclassesTimelineLite

SimpleTimeline is the base class for the TimelineLite and TimelineMax classes. It provides the most basic timeline functionality and is used for the root timelines in TweenLite. It is meant to be very fast and lightweight.

Copyright 2009, GreenSock. All rights reserved. This work is subject to the terms in http://www.greensock.com/terms_of_use.html or for corporate Club GreenSock members, the software agreement that was issued with the corporate membership.


Public Properties
 PropertyDefined by
  autoRemoveChildren : Boolean
If a timeline's autoRemoveChildren is true, its children will be removed and made eligible for garbage collection as soon as they complete.
SimpleTimeline
 InheritedcurrentTime : Number
Most recently rendered time (or frame for frames-based tweens/timelines) according to its duration.
TweenCore
 Inheriteddata : *
Place to store any data you want.
TweenCore
 Inheriteddelay : Number
Length of time in seconds (or frames for frames-based tweens/timelines) before the tween should begin.
TweenCore
 Inheritedduration : Number
Duration of the tween in seconds (or frames for frames-based tweens/timelines) not including any repeats or repeatDelays.
TweenCore
 Inheritedpaused : Boolean
Indicates the paused state of the tween/timeline.
TweenCore
 Inheritedreversed : Boolean
Indicates the reversed state of the tween/timeline.
TweenCore
 InheritedstartTime : Number
Start time in seconds (or frames for frames-based tweens/timelines), according to its position on its parent timeline
TweenCore
 Inheritedtimeline : SimpleTimeline
The parent timeline on which the tween/timeline is placed.
TweenCore
 InheritedtotalDuration : Number
Duration of the tween in seconds (or frames for frames-based tweens/timelines) including any repeats or repeatDelays (which are only available on TweenMax and TimelineMax).
TweenCore
 InheritedtotalTime : Number
Most recently rendered time (or frame for frames-based tweens/timelines) according to its totalDuration.
TweenCore
 Inheritedvars : Object
Stores variables (things like alpha, y or whatever we're tweening as well as special properties like "onComplete").
TweenCore
Public Methods
 MethodDefined by
  
SimpleTimeline(vars:Object = null)
SimpleTimeline
 Inherited
complete(skipRender:Boolean = false, suppressEvents:Boolean = false):void
Forces the tween/timeline to completion.
TweenCore
 Inherited
invalidate():void
Clears any initialization data (like starting values in tweens) which can be useful if, for example, you want to restart it without reverting to any previously recorded starting values.
TweenCore
 Inherited
kill():void
Kills the tween/timeline, stopping it immediately.
TweenCore
 Inherited
pause():void
Pauses the tween/timeline
TweenCore
 Inherited
play():void
Starts playing forward from the current position.
TweenCore
 Inherited
restart(includeDelay:Boolean = false, suppressEvents:Boolean = true):void
Restarts and begins playing forward.
TweenCore
 Inherited
resume():void
Starts playing from the current position without altering direction (forward or reversed).
TweenCore
 Inherited
reverse(forceResume:Boolean = true):void
Reverses smoothly, adjusting the startTime to avoid any skipping.
TweenCore
Property detail
autoRemoveChildrenproperty
public var autoRemoveChildren:Boolean

If a timeline's autoRemoveChildren is true, its children will be removed and made eligible for garbage collection as soon as they complete. This is the default behavior for the main/root timeline.

Constructor detail
SimpleTimeline()constructor
public function SimpleTimeline(vars:Object = null)Parameters
vars:Object (default = null)