To download the code, you must agree to the following license:

Copyright 2010, GreenSock, Inc.

"NO CHARGE" NON-EXCLUSIVE SOFTWARE LICENSE AGREEMENT
-----------------------------------------------------------------------------
PLAIN ENGLISH SUMMARY:

  1. You may use the code at no charge in commercial or non-commercial web sites, games, components, applications, and other software as long as end users are not charged a fee of any kind to use your product or gain access to any part of it. If your client pays you a one-time fee to create the site/product, that's perfectly fine and qualifies under the "no charge" license. If end users are charged a usage/access/license fee, please sign up for a corporate Club GreenSock membership which comes with a special commercial license granting you permission to do so. See http://www.greensock.com/club/ for details.
  2. Use at your own risk. No warranties are offered.
  3. Please respect the copyright.

-----------------------------------------------------------------------------

LEGALESE:

This is a legal agreement between you (either an individual or a single entity) and GreenSock, Inc. ("GREENSOCK") for the proprietary GreenSock ActionScript code known as TweenLite, TweenMax, TweenNano, TimelineLite, TimelineMax, and other code that is available for download at http://www.greensock.com (this code and documentation, as well as any updates which may at GREENSOCK's sole discretion be provided to you from time to time, are referred to in this Agreement as "PROGRAM") By downloading, copying, or otherwise using the PROGRAM, you agree to the terms and conditions of this Agreement. If you do not agree to the terms and conditions of this Agreement, please do not download or use the PROGRAM.

I. LICENSE
A. Subject to the terms and conditions of this Agreement, GREENSOCK hereby grants you a non-exclusive, worldwide, non-transferable right to use the PROGRAM in web sites, games, components and other software applications for which the end user is NOT charged any fees. If you would like to use the code in a commercially licensed software product for which end users are charged a fee (either for usage or access), simply sign up for a corporate Club GreenSock membership at http://www.greensock.com/club/.

II. LIMITATION OF LICENSE AND RESTRICTIONS
A. You agree that you will not disclose, sell, rent, or license the PROGRAM's source code or any derivative works thereof to any third party without the prior written consent of GREENSOCK. Derivative works are defined as modifications that add substantive functionality to the PROGRAM and do not include bug fixes or other minor modifications required to operate the PROGRAM as originally intended. Distribution of the source code as part of your Work Product is acceptable so long as the recipients agree to the terms of this Agreement. You agree not to modify or delete GREENSOCK'S existing copyright notice located in the source code.

B. You may use, duplicate, and distribute the compiled object code as embedded in a Work Product created by you, either for your own use or for distribution to a third party so long as end users of the Work Product are not charged a fee for usage of or access to any portion of the Work Product. Please see http://www.greensock.com/licensing/ for descriptions of Work Products that qualify for the "No Charge" license.

III. CONSIDERATION
A. The license rights granted to you under this Agreement are at no charge, but only in the following circumstances: If on your own behalf or on behalf of a third party you incorporate the PROGRAM into a web site, game, software application, program or any component thereof (collectively, "Work Product"), which in the case of a web site, must be accessible to internet users without payment of a fee of any kind, and in the case of a software application, game, program or component, neither you nor anyone to whom you distribute the Work Product charges a user a fee of any kind to use such Work Product or application, game, program or component into which such Work Product is embedded. The foregoing shall apply regardless of whether you are paid to create such Work Product.

B. In the event your intended use of the PROGRAM does not meet the criteria for the "no charge" license rights set forth in the immediately preceding paragraph, then you are not licensed to use the PROGRAM under this Agreement and must license the PROGRAM under GREENSOCK'S separate fee-based Software License Agreement which is granted to corporate Club GreenSock members (see http://www.greensock.com/club/ for details).

IV. TITLE AND OWNERSHIP
A. The PROGRAM is licensed, not sold, and is protected by copyright laws and international treaty provisions. You acknowledge that no title to the intellectual property in the PROGRAM is transferred to you. You further acknowledge that title and full ownership rights to the PROGRAM, including all intellectual property rights therein, will remain the exclusive property of GREENSOCK and you will not acquire any rights to the PROGRAM except as expressly set forth in this Agreement. You agree that any copies of the PROGRAM you make will contain the same proprietary notices which appear on and in the PROGRAM. You agree that GREENSOCK may identify you as a licensee unless you make a written request otherwise. GREENSOCK hereby grants to you the right to disclose that your product, game, software application, component, or other Work Product makes use of GREENSOCK code (for example, "Powered by TweenLite").

V. DISCLAIMER OF WARRANTY AND LIMITATION OF LIABILITY
A. THE PROGRAM IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. GREENSOCK DOES NOT WARRANT THAT THE FUNCTIONS CONTAINED IN THE PROGRAM WILL MEET YOUR REQUIREMENTS OR THAT OPERATION WILL BE UNINTERRUPTED OR ERROR FREE. GREENSOCK shall not be liable for special, indirect, incidental, or consequential damages with respect to any claim on account of or arising from this Agreement or use of the PROGRAM, even if GREENSOCK has been or is hereafter advised of the possibility of such damages. Because some states do not allow certain exclusions or limitations on implied warranties or of liability for consequential or incidental damages, the above exclusions may not apply to you. In no event, however, will GREENSOCK be liable to you, under any theory of recovery, in an amount in excess of $250. Notwithstanding anything else in this agreement, you agree to indemnify GREENSOCK, its assignees, and licensees, and hold each of them harmless from and against any and all claims, demands, losses, damages, liabilities, costs, and expenses, including legal fees resulting from your use of the PROGRAM.

B. GREENSOCK may, at its sole discretion, provide support services related to the PROGRAM, but has no obligation to do so.

VI. TERMINATION
If you at any time fail to abide by the terms of this Agreement, GREENSOCK shall have the right to immediately terminate the license granted herein, require the return or destruction of all copies of the PROGRAM from you and certification in writing as to such return or destruction, and pursue any other legal or equitable remedies available.

VII. MISCELLANEOUS
A. This Agreement shall be construed in accordance with the laws of the State of Illinois. In the event of any dispute between you and GREENSOCK with respect to this Agreement, we both agree that if we cannot resolve the dispute in good faith discussion, either of us may submit the dispute for resolution to arbitration with the American Arbitration Association before a single arbitrator using the AAA Rules for Commercial Arbitration. The arbitrator's decision is final and can be enforced in any court with jurisdiction over such matters.

B. This agreement represents the complete and exclusive statement of the agreement between GREENSOCK and you and supersedes all prior agreements, proposals, representations and other communications, verbal or written, between them with respect to use of the program. This agreement may be modified only with the mutual written approval of authorized representatives of the parties.

C. The terms and conditions of this Agreement shall prevail notwithstanding any different, conflicting, or additional terms or conditions which may appear in any purchase order or other document submitted by you. You agree that such additional or inconsistent terms are deemed rejected by GREENSOCK.

D. GREENSOCK and you agree that any xerographically or electronically reproduced copy of this Agreement shall have the same legal force and effect as any copy bearing original signatures of the parties.

I'd like to learn how to get bonus plugins, update notifications, SVN access, and more.
To join Club GreenSock, you must agree to the following license:
Featured projects
Tweening Platform v11 TransformManager
SplitTextField
Become a member
Club GreenSock
Licensing
Forums
About
Projects by category
layout
Preloading
Text
Transforming
Tweening
XML
RSS
RSS
Comments RSS
Documentation
Getting Started
Speed Tests
Feature Comparison
Join Club GreenSock
annacarmi.co.il
Sony Bloggie
MicroManiac
diva.net.au
Hothouse Experiment
» Showcase your work

TimelineMax – Sequence/Group Multiple Tweens, Control Them as a Whole

  • Version: 1.2, Updated 2010-03-06
  • File size added to compressed SWF: about 4.9k (base), 10.4k with OverwriteManager and TweenLite

Watch a video that explains the basics of working with TimelineLite and TimelineMax.

Description

TimelineMax extends TimelineLite, offering exactly the same functionality plus useful (but non-essential) features like AS3 event dispatching, repeat, repeatDelay, yoyo, currentLabel, addCallback(), removeCallback(), tweenTo(), tweenFromTo(), getLabelAfter(), getLabelBefore(), and getActive() (and probably more in the future). It is the ultimate sequencing tool. Think of a TimelineMax instance like a virtual MovieClip timeline or a container where you position tweens (or other timelines) over the course of time. You can:

  • build sequences easily by adding tweens with the append(), prepend(), insert(), appendMultiple(), prependMultiple(), and insertMultiple() methods. Tweens can overlap as much as you want and you have complete control over where they get placed on the timeline.
  • add labels, play(), stop(), gotoAndPlay(), gotoAndStop(), restart(), tweenTo() and even reverse()!
  • nest timelines within timelines as deeply as you want.
  • set the progress of the timeline using its currentProgress property. For example, to skip to the halfway point, set myTimeline.currentProgress = 0.5;
  • tween the currentTime, totalTime, currentProgress, or totalProgress property to fastforward/rewind the timeline. You could even attach a slider to one of these properties to give the user the ability to drag forwards/backwards through the whole timeline.
  • add onStart, onUpdate, onComplete, onReverseComplete, and/or onRepeat callbacks using the constructor's vars object.
  • speed up or slow down the entire timeline with its timeScale property. You can even tween this property to gradually speed up or slow down the timeline.
  • use the insertMultiple(), appendMultiple(), or prependMultiple() methods to create complex sequences including various alignment modes and staggering capabilities. Works great in conjunction with TweenMax.allTo() too.
  • base the timing on frames instead of seconds if you prefer. Please note, however, that the timeline's timing mode dictates its childrens' timing mode as well.
  • kill the tweens of a particular object inside the timeline with killTweensOf() or get the tweens of an object with getTweensOf() or get all the tweens/timelines in the timeline with getChildren()
  • set the timeline to repeat any number of times or indefinitely. You can even set a delay between each repeat cycle and/or cause the repeat cycles to yoyo, appearing to reverse every other cycle.
  • listen for START, UPDATE, REPEAT, REVERSE_COMPLETE, and COMPLETE events.
  • get the active tweens in the timeline with getActive().
  • add callbacks (function calls) anywhere in the timeline that call a function of your choosing when the "virtual playhead" passes a particular spot.
  • Get the currentLabel or find labels at various positions in the timeline using getLabelAfter() and getLabelBefore()

Interactive example

Sample AS3 code

PLAIN TEXT
Actionscript:
  1. import com.greensock.*;
  2.  
  3. //create the timeline and add an onComplete call to myFunction when the timeline completes
  4. var myTimeline:TimelineMax = new TimelineMax({onComplete:myFunction});
  5.  
  6. //add a tween
  7. myTimeline.append(new TweenLite(mc, 1, {x:200, y:100}));
  8.  
  9. //add another tween at the end of the timeline (makes sequencing easy)
  10. myTimeline.append(new TweenLite(mc, 0.5, {alpha:0}));
  11.  
  12. //repeat the entire timeline twice
  13. myTimeline.repeat = 2;
  14.  
  15. //delay the repeat by 0.5 seconds each time.
  16. myTimeline.repeatDelay = 0.5;
  17.  
  18. //pause the timeline (stop() works too)
  19. myTimeline.pause();
  20.  
  21. //reverse it anytime...
  22. myTimeline.reverse();
  23.  
  24. //Add a "spin" label 3-seconds into the timeline.
  25. myTimeline.addLabel("spin", 3);
  26.  
  27. //insert a rotation tween at the "spin" label (you could also define the insert point as the time instead of a label)
  28. myTimeline.insert(new TweenLite(mc, 2, {rotation:"360"}), "spin");
  29.  
  30. //go to the "spin" label and play the timeline from there...
  31. myTimeline.gotoAndPlay("spin");
  32.  
  33. //call myCallback when the "virtual playhead" travels past the 1.5-second point.
  34. myTimeline.addCallback(myCallback, 1.5);
  35.  
  36. //add a tween to the beginning of the timeline, pushing all the other existing tweens back in time
  37. myTimeline.prepend(new TweenMax(mc, 1, {tint:0xFF0000}));
  38.  
  39. //nest another TimelineMax inside your timeline...
  40. var nestedTimeline:TimelineMax = new TimelineMax();
  41. nestedTimeline.append(new TweenLite(mc2, 1, {x:200}));
  42. myTimeline.append(nestedTimeline);

insertMultiple() and appendMultiple() provide some very powerful sequencing capabilities, allowing you to add an Array of tweens (using TweenLite/Max instances or the new shorthand syntax, like [mc, 1, {x:100}]) and optionally align them with SEQUENCE or START modes, and even stagger them if you want. For example, to insert 3 tweens into the timeline, aligning their start times but staggering them by 0.2 seconds,

PLAIN TEXT
Actionscript:
  1. myTimeline.insertMultiple([new TweenLite(mc, 1, {y:"100"}),
  2.                         new TweenLite(mc2, 1, {x:120}),
  3.                         new TweenLite(mc3, 1, {alpha:0.5})],
  4.                         0,
  5.                         TweenAlign.START,
  6.                         0.2);

You can use the constructor's "vars" object to do virtually all the setup too, like this sequence:

PLAIN TEXT
Actionscript:
  1. var myTimeline:TimelineMax = new TimelineMax({tweens:[new TweenLite(mc1, 1, {y:"100"}), TweenMax.to(mc2, 1, {tint:0xFF0000})], align:TweenAlign.SEQUENCE, onComplete:myFunction});

If that confuses you, don't worry. Just use the append(), insert(), and prepend() methods to build your sequence. But power users will likely appreciate the quick, compact way they can set up sequences now.

Watch a video that explains the basics of working with TimelineLite and TimelineMax.

Documentation

Please view full ASDoc documentation here.

FAQ

  1. Does TimelineMax only work with TweenMax instances? Can I use TweenLite too?
    You can put ANY (or all) of the following into a TimelineMax: TweenLite tweens, TweenMax tweens, TimelineLite timelines or other TimelineMax timelines. It's an integrated suite. Go crazy mixing and matching. The only part of the platform that doesn't work with TimelineLite/Max is the freakishly tiny TweenNano class.
  2. Do the AS2 and AS3 versions work exactly the same?
    Yes. To accommodate scope issues that are inherent in AS2, however, the AS2 version of TimelineMax also recognizes the following special properties to define the scope of callbacks: onStartScope, onUpdateScope, onRepeatScope, onCompleteScope, and onReverseCompleteScope. These are not necessary in AS3. Obviously the AS2 version doesn't offer AS3 event dispatching either.
  3. How can I make a TimelineMax repeat infinitely?
    Just set its "repeat" property to -1.
  4. If I reverse() a TimelineMax right after I create it, nothing happens. Why?
    reverse() simply causes the timeline to change direction and go back towards its starting point, but if it is already there (if it never got past its starting point), there's nowhere for it to go. There's nothing wrong with reversing a timeline when it's at its starting point, but keep in mind that doing so doesn't force it to jump all the way to the end. You can easily do that with myTimeline.progress = 1 though.
  5. How do I install the class? Do I have to import it on every frame?
    Just make sure the "com" folder from the download is in the same folder as your FLA file. Keep the directory structure in the "com" folder, though (the class files are inside a "greensock" folder that belongs inside the "com" folder). That's it. And, yes, just like any class, you need to import TimelineMax at the top of any frame that contains code referencing it. This does NOT add extra kb to your file size every time you import it. Flash is smart enough to embed it once and all the other import statements just act as a "pointer" to the embedded class.
  6. Can I put the same tween in multiple timelines?
    No. Every tween and timeline has one (and only one) parent timeline. Think of them like DisplayObjects/MovieClips - they cannot exist in two places at once. They can only have one parent.
  7. What's the difference between TimelineLite and TimelineMax? Don't they do pretty much the same thing?
    TimelineLite contains all the essentials, but TimelineMax extends it and adds more features (just like TweenLite and TweenMax). So TimelineMax can do EVERYTHING TimelineLite does plus more, like AS3 event dispatching, repeat, repeatDelay, yoyo, addCallback(), getActive(), tweenTo(), tweenFromTo(), getLabelBefore(), getLabelAfter(), currentLabel, etc. If you don't need any of those features, stick with TimelineLite.
  8. Do I have to purchase a license to use this code? Can I use it for commercial purposes?
    You may use the code at no charge in commercial or non-commercial web sites, games, components, applications, and other software as long as end users are not charged a fee of any kind to use your product or gain access to it. If your client pays you a one-time fee to create the site/product, that's perfectly fine and qualifies under the "no charge" license. If multiple end users are charged a usage/access/license fee of any kind, please simply sign up for a corporate Club GreenSock membership which comes with a special commercial license granting you permission to do so. See http://www.greensock.com/club/ for details. Club GreenSock members get several nifty bonus plugins, classes, update notifications, SVN access, and more. Your donations keep this project going. Please see the licensing page for details on licensing.

Need help?

Feel free to post your question on the forums. You'll increase your chances of getting a prompt answer if you provide a brief explanation and include a simplified FLA file (and any class files) that clearly demonstrates the problem.

Donate
Author: Jack Doyle
Copyright 2010, GreenSock (This work is subject to the terms here.)

Comments (4) RSS

Posted by Vasya on December 10, 2009

is it possible to use this Sample AS3 code in AS2 ? thanks

Posted by admin on December 10, 2009

Sure, Vasya, you can use the same code for the AS2 version – the only exception is that some of the tween properties would be slightly different (like “x” in AS3 is “_x” in AS2, and same for “y”/”_y”, “alpha”/”_alpha”, etc.). The TimelineMax code itself uses exactly the same syntax in AS2 and AS3.

Posted by Tony on January 7, 2010

Is it possible to tween the timeScale of a single timeline within a master timeline?

Posted by admin on January 7, 2010

Sure, Tony, you can tween the timeScale of a nested TimelineLite/Max.

© 2010, GreenSock, Inc. | terms of use | info@greensock.com