GreenSock

• Compatibility: AS2 and AS3 versions available
• File Size added to published SWF: About 1Kb

Join Club GreenSock to get updates, bonus classes, and more

DESCRIPTION

OverwriteManager is included in all TweenLite/TweenFilterLite/TweenMax downloads and allows you to control how tweens with overlapping properties are handled. Without OverwriteManager, tweens of the same object are always completely overwritten unless you set overwrite:0 (previously overwrite:false which still works by the way). For example:

So even though there are no overlapping properties in the previous example, the 2nd tween would overwrite the first. The primary reason for this has to do with speed and file size. But if you're willing to sacrifice a little speed and file size, OverwriteManager can work with the tweening classes to automatically sense when there are overlapping properties and then only overwrite the individual properties in the other tween(s). Don't worry, you'd probably never notice even a slight speed decrease unless hundreds of tweens are beginning simultaneously with overlapping properties.

I kept OverwriteManager as a separate, optional class primarily because of file size concerns. I know, you're probably thinking "what the heck? It's not even 1Kb! What's the big deal?". Well, there are thousands of developers using TweenLite because of its extremely small footprint and blistering speed. Even 1Kb would represent a 33% increase in file size, and some developers have no use for the capabilities of this class.

So OverwriteManager is an optional enhancement to TweenLite and TweenFilterLite, but it is automatically included with TweenMax without any additional steps required on your part. That also means that if you use TweenMax anywhere in your project, OverwriteManager will automatically get initted and will therefore affect TweenLite and TweenFilterLite, making their default mode "AUTO" instead of "ALL".

USAGE

OverwriteManager has four modes: NONE, ALL, AUTO, and CONCURRENT. Without OverwriteManager, TweenLite and TweenFilterLite only have access to the NONE and ALL modes. With OverwriteManager initted, however, you get access to them all. By default, OverwriteManager uses AUTO. Here's what they do:

• NONE (0): No tweens are overwritten. This is the fastest mode, but you need to be careful not to create any tweens with overlapping properties, otherwise they'll conflict with each other.
• ALL (1): Similar to the default behavior of TweenLite/TweenFilterLite/TweenMax where all tweens of the same object are completely overwritten immediately when the tween is created.
  1. TweenLite.to(mc, 1, {x:100, y:200});
  2. TweenLite.to(mc, 1, {x:300, delay:2}); //immediately overwrites the previous tween

• AUTO (2): Searches for and overwrites only individual overlapping properties in tweens that are running at the time the tween begins.
  1. TweenLite.to(mc, 1, {x:100, y:200});
  2. TweenLite.to(mc, 1, {x:300}); //only overwrites the "x" property in the previous tween

• CONCURRENT (3): Overwrites all tweens of the same object that are active at the time the tween begins.
  1. TweenLite.to(mc, 1, {x:100, y:200});
  2. TweenLite.to(mc, 1, {x:300, delay:2}); //does NOT overwrite the previous tween because the first tween will have finished by the time this one begins.

To add OverwriteManager's capabilities to TweenLite and TweenFilterLite, you must init() the class once (typically on the first frame of your file) like so:

You do NOT need to add this line if you're using TweenMax because it automatically does it internally.

EXAMPLES

FAQ

1. I'm trying to use the AUTO overwriting mode, but it's not working - what am I doing wrong?
   You probably just forgot to call OverwriteManager.init() in your SWF. You only need to do that ONCE by the way. And be sure you're using the latest version of tweening classes and that you imported the OverwriteManager class too, either with import gs.OverwriteManager; or import gs.*;
2. What if I set the mode to AUTO, but I have a tween that I'd like to use a different mode for - can I do that?
   Of course. Just use the overwrite property in that tween, like:
   1. TweenMax.to(mc, 1, {x:100, overwrite:3}); //uses the CONCURRENT mode for this tween even if the OverwriteManager's mode is something different.

3. Is there a big performance hit when using the AUTO mode?
   Not really. Maybe if you're starting hundreds of simultaneous tweens with overlapping properties, but you'd probably never notice ANY difference whatsoever in typical use. If you want the absolute best speed, stick with the ALL or NONE modes.
4. Where do I get the OverwriteManager class?
   It's included in all of the TweenLite/TweenFilterLite/TweenMax downloads.

Need Help?

Feel free to e-mail me a question. Or post your question on the new forums. I'd highly recommend joining Club GreenSock to get prioritized access to my time in answering your question, and so that you receive updates and lots more. When you e-mail your question, please include a simplified FLA file (and any class files) that clearly demonstrates the problem and provide a brief explanation.