API Documentation | All Packages | All Classes | Index | Frames No Frames |
Class SimpleTimeline

Package | com.greensock.core
Class | public class SimpleTimeline
Inheritance | SimpleTimeline TweenCore
Subclasses | TimelineLite

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 2011, 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
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined 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
|  | currentTime : Number Most recently rendered time (or frame for frames-based tweens/timelines) according to its `duration`. | TweenCore
|  | data : * Place to store any data you want. | TweenCore
|  | delay : Number Length of time in seconds (or frames for frames-based tweens/timelines) before the tween should begin. | TweenCore
|  | duration : Number Duration of the tween in seconds (or frames for frames-based tweens/timelines) not including any repeats or repeatDelays. | TweenCore
|  | paused : Boolean Indicates the paused state of the tween/timeline. | TweenCore
|  | reversed : Boolean Indicates the reversed state of the tween/timeline. | TweenCore
|  | startTime : Number Start time in seconds (or frames for frames-based tweens/timelines), according to its position on its parent timeline | TweenCore
|  | timeline : SimpleTimeline The parent timeline on which the tween/timeline is placed. | TweenCore
|  | totalDuration : 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
|  | totalTime : Number Most recently rendered time (or frame for frames-based tweens/timelines) according to its `totalDuration`. | TweenCore
|  | vars : Object Stores variables (things like alpha, y or whatever we're tweening as well as special properties like "onComplete"). | TweenCore

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined by
--- | --- | ---
|  | SimpleTimeline(vars:Object = null) | SimpleTimeline
|  | complete(skipRender:Boolean = false, suppressEvents:Boolean = false):void Forces the tween/timeline to completion. | TweenCore
|  | insert(tween:TweenCore, time:* = 0):TweenCore Inserts a TweenLite, TweenMax, TimelineLite, or TimelineMax instance into the timeline at a specific time. | SimpleTimeline
|  | 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
|  | kill():void Kills the tween/timeline, stopping it immediately. | TweenCore
|  | pause():void Pauses the tween/timeline | TweenCore
|  | play():void Starts playing forward from the current position. | TweenCore
|  | restart(includeDelay:Boolean = false, suppressEvents:Boolean = true):void Restarts and begins playing forward. | TweenCore
|  | resume():void Starts playing from the current position without altering direction (forward or reversed). | TweenCore
|  | reverse(forceResume:Boolean = true):void Reverses smoothly, adjusting the startTime to avoid any skipping. | TweenCore

Property detail

autoRemoveChildren | property

`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`)``

Method detail

insert | () | method

`public function insert(tween:TweenCore, time:* = 0):TweenCore`

Inserts a TweenLite, TweenMax, TimelineLite, or TimelineMax instance into the timeline at a specific time.

Parameters

| `tween:TweenCore` — TweenLite, TweenMax, TimelineLite, or TimelineMax instance to insert
| `time:*` (default = `0`)`` — The time in seconds (or frames for frames-based timelines) at which the tween/timeline should be inserted. For example, myTimeline.insert(myTween, 3) would insert myTween 3-seconds into the timeline.

Returns

| `TweenCore` — TweenLite, TweenMax, TimelineLite, or TimelineMax instance that was inserted