Documentation for classes includes syntax, usage information, and code samples for methods, properties, and event handlers and listeners for those APIs that belong to a specific class in ActionScript. The classes are listed alphabetically. If you are not sure to which class a certain method or property belongs, you can look it up in the Index.
| Class | Package | Description | |
|---|---|---|---|
| AlignMode | com.greensock.layout | Provides constants for defining the alignment of objects. | |
| Animation | com.greensock.core | Base class for all TweenLite, TweenMax, TimelineLite, and TimelineMax classes, providing core methods/properties/functionality, but there is no reason to create an instance of this class directly. | |
| AutoAlphaPlugin | com.greensock.plugins | [AS3/AS2 only, although autoAlpha is recognized inside the CSSPlugin for JavaScript] Tweening "autoAlpha" is exactly the same as tweening an object's "alpha" except that it ensures that the object's "visible" property is true until autoAlpha reaches zero at which point it will toggle the "visible" property to false. | |
| AutoFitArea | com.greensock.layout | AutoFitArea allows you to define a rectangular area and then attach() DisplayObjects so that they automatically fill the area, scaling/stretching in any of the following modes: STRETCH, PROPORTIONAL_INSIDE, PROPORTIONAL_OUTSIDE, NONE, WIDTH_ONLY, or HEIGHT_ONLY. | |
| Back | com.greensock.easing | Eases with an overshoot either at the beginning (easeIn), the end (easeOut), or both (easeInOut). | |
| BevelFilterPlugin | com.greensock.plugins | [AS3/AS2 only] Tweens a BevelFilter. | |
| BezierPlugin | com.greensock.plugins | Animate virtually any property (or properties) along a Bezier (curved) path which you define as an array of points/values that can be interpreted 4 different ways (described as the Bezier's "type", like type:"quadratic"): "thru" (the default) - the plugin figures out how to draw the Bezier naturally through the supplied values using a proprietary GreenSock algorithm. | |
| BinaryDataLoader | com.greensock.loading | Loads generic binary data - identical to using a DataLoader with its "format" special property set to "binary". | |
| BlitMask | com.greensock | [AS3 only] A BlitMask is basically a rectangular Sprite that acts as a high-performance mask for a DisplayObject by caching a bitmap version of it and blitting only the pixels that should be visible at any given time, although its bitmapMode can be turned off to restore interactivity in the DisplayObject whenever you want. | |
| BlurFilterPlugin | com.greensock.plugins | [AS3/AS2 only] Tweens a BlurFilter. | |
| Bounce | com.greensock.easing | Eases, bouncing either at the beginning (easeIn), the end (easeOut), or both (easeInOut). | |
| CacheAsBitmapPlugin | com.greensock.plugins | [AS3/AS2 only] Forces the cacheAsBitmap property of a DisplayObject to be a certain value (true or false) during the tween and then sets it back to whatever it was before the tween was rendered for the first time. | |
| Circ | com.greensock.easing | Eases with an abrupt change in velocity either at the beginning (easeIn), the end (easeOut), or both (easeInOut). | |
| CirclePath2D | com.greensock.motionPaths | [AS3 only] A CirclePath2D defines a circular path on which a PathFollower can be placed, making it simple to tween objects along a circle or oval (make an oval by altering the width/height/scaleX/scaleY properties). | |
| CirclePath2DPlugin | com.greensock.plugins | [AS3 only] Tweens an object along a CirclePath2D motion path in any direction (clockwise, counter-clockwise, or shortest). | |
| ColorMatrixFilterPlugin | com.greensock.plugins | [AS3/AS2 only] ColorMatrixFilter tweening offers an easy way to tween a DisplayObject's saturation, hue, contrast, brightness, and colorization. | |
| ColorTransformPlugin | com.greensock.plugins | [AS3/AS2 only] Ever wanted to tween ColorTransform properties of a DisplayObject to do advanced effects like overexposing, altering the brightness or setting the percent/amount of tint? Or maybe tween individual ColorTransform properties like redMultiplier, redOffset, blueMultiplier, blueOffset, etc. | |
| ContentDisplay | com.greensock.loading.display | A container for visual content that is loaded by any of the following: ImageLoaders, SWFLoaders, or VideoLoaders. | |
| CSSLoader | com.greensock.loading | Loads StyleSheet (CSS) data. | |
| CSSLoaderVars | com.greensock.loading.data | Can be used instead of a generic Object to define the vars parameter of a CSSLoader's constructor. | |
| Cubic | com.greensock.easing | Provides an easeIn, easeOut, and easeInOut with a power (or strength) of 2 which is identical to the Power2 ease. | |
| CustomEase | com.greensock.easing | [AS3/AS2 only] Facilitates creating custom bezier eases with the GreenSock Custom Ease Builder tool. | |
| DataLoader | com.greensock.loading | Loads generic data which can be text (the default), binary data, or URL-encoded variables. | |
| DataLoaderVars | com.greensock.loading.data | Can be used instead of a generic Object to define the vars parameter of a DataLoader's constructor. | |
| Direction | com.greensock.motionPaths | [AS3 only] Constants for defining the direction in which to travel on a MotionPath (like CLOCKWISE, COUNTER_CLOCKWISE, SHORTEST, etc.). | |
| DirectionalRotationPlugin | com.greensock.plugins | Tweens any rotation-related property to another value in a particular direction which can be either clockwise ("_cw" suffix), counter-clockwise ("_ccw" suffix), or in the shortest direction ("_short" suffix) in which case the plugin chooses the direction based on the shortest path. | |
| DisplayObjectLoader | com.greensock.loading.core | Serves as the base class for SWFLoader and ImageLoader. | |
| DropShadowFilterPlugin | com.greensock.plugins | [AS3/AS2 only] Tweens a DropShadowFilter. | |
| DynamicPinPoint | com.greensock.layout | Sometimes it's useful to have a PinPoint base its coordinates on some custom criteria, like the edge of another DisplayObject or the center of an object whose width/height changes frequently, so DynamicPinPoint allows you to associate a function (one you define) that returns a Point instance that will determine the DynamicPinPoint's x/y values. | |
| DynamicPropsPlugin | com.greensock.plugins | [AS3/AS2 only] If you'd like to tween something to a destination value that may change at any time, DynamicPropsPlugin allows you to simply associate a function with a property so that every time the tween is rendered, it calls that function to get the new destination value for the associated property. | |
| Ease | com.greensock.easing | Base class for all GreenSock easing equations. | |
| EaseLookup | com.greensock.easing | EaseLookup enables you to find the easing function associated with a particular name (String), like "strongEaseOut" which can be useful when loading in XML data that comes in as Strings but needs to be translated to native function references. | |
| Elastic | com.greensock.easing | Eases with an elastic effect either at the beginning (easeIn), the end (easeOut), or both (easeInOut). | |
| EndArrayPlugin | com.greensock.plugins | [AS3/AS2 only] Tweens numbers in an Array. | |
| EndVectorPlugin | com.greensock.plugins | [AS3 only] Tweens numbers in a Vector.<Number>. | |
| Expo | com.greensock.easing | Eases in a strong fashion either at the beginning (easeIn), the end (easeOut), or both (easeInOut). | |
| FlexBlitMask | com.greensock | [AS3 only] A FlexBlitMask is basically a rectangular UIComponent that acts as a high-performance mask for a DisplayObject by caching a bitmap version of it and blitting only the pixels that should be visible at any given time, although its bitmapMode can be turned off to restore interactivity in the DisplayObject whenever you want. | |
| FlexContentDisplay | com.greensock.loading.display | A container for visual content that is loaded by any of the following: ImageLoaders, SWFLoaders, or VideoLoaders which is to be used in Flex. | |
| FlexSplitTextField | com.greensock.text | FlexSplitTextField makes it easy to break apart the TextField in a UIComponent like a Label, Text, or TextArea so that each character, word, or line is in its own TextField, making complex animation simple. | |
| FrameBackwardPlugin | com.greensock.plugins | [AS3/AS2 only] Tweens a MovieClip backward to a particular frame number, wrapping it if/when it reaches the beginning of the timeline. | |
| FrameForwardPlugin | com.greensock.plugins | [AS3/AS2 only] Tweens a MovieClip forward to a particular frame number, wrapping it if/when it reaches the end of the timeline. | |
| FrameLabelPlugin | com.greensock.plugins | [AS3/AS2 only] Tweens a MovieClip to a particular frame label. | |
| FramePlugin | com.greensock.plugins | [AS3/AS2 only] Tweens a MovieClip to a particular frame number. | |
| GlowFilterPlugin | com.greensock.plugins | [AS3/AS2 only] Tweens a GlowFilter. | |
| HexColorsPlugin | com.greensock.plugins | [AS3/AS2 only] Although hex colors are technically numbers, if you try to tween them conventionally, you'll notice that they don't tween smoothly. | |
| ImageLoader | com.greensock.loading | Loads an image file (png, jpg, or gif) and automatically applies smoothing by default. | |
| ImageLoaderVars | com.greensock.loading.data | Can be used instead of a generic object to define the vars parameter of an ImageLoader's constructor. | |
| Linear | com.greensock.easing | Linear ease with no acceleration or deceleration. | |
| LinePath2D | com.greensock.motionPaths | [AS3 only] A LinePath2D defines a path (using as many Points as you want) on which a PathFollower can be placed and animated. | |
| LiquidArea | com.greensock.layout | LiquidArea is an AutoFitArea that integrates with LiquidStage, automatically adjusting its size whenever the stage is resized. | |
| LiquidPositionPlugin | com.greensock.plugins | [AS3 only] If you're using LiquidStage and you'd like to tween a DisplayObject to coordinates that are relative to a particular PinPoint (like the CENTER) whose position may change at any time, LiquidPositionPlugin makes it easy by dynamically updating the destination values accordingly. | |
| LiquidStage | com.greensock.layout | LiquidStage allows you to "pin" DisplayObjects to reference points on the stage (or inside other DisplayObjects) so that when the stage is resized, they are repositioned and maintain their relative distance from the PinPoint. | |
| LoaderCore | com.greensock.loading.core | Serves as the base class for GreenSock loading tools like LoaderMax, ImageLoader, XMLLoader, SWFLoader, etc. | |
| LoaderEvent | com.greensock.events | An Event dispatched by one of the loaders in the LoaderMax system. | |
| LoaderItem | com.greensock.loading.core | Serves as the base class for all individual loaders (not LoaderMax) like ImageLoader, XMLLoader, SWFLoader, MP3Loader, etc. | |
| LoaderMax | com.greensock.loading | In its simplest form, a LoaderMax provides a way to group a sequence of loaders together and report their progress as a whole. | |
| LoaderMaxVars | com.greensock.loading.data | Can be used instead of a generic Object to define the vars parameter of a LoaderMax's constructor. | |
| LoaderStatus | com.greensock.loading | Defines status values for loaders. | |
| MotionBlurPlugin | com.greensock.plugins | [AS3/AS2 only] MotionBlurPlugin provides an easy way to apply a directional blur to a DisplayObject based on its velocity and angle of movement in 2D (x/y). | |
| MotionPath | com.greensock.motionPaths | [AS3 only] A MotionPath defines a path along which a PathFollower can travel, making it relatively simple to do things like tween an object in a circular path. | |
| MP3Loader | com.greensock.loading | Loads an MP3 audio file and also provides convenient playback methods and properties like pauseSound(), playSound(), gotoSoundTime(), playProgress, volume, soundPaused, duration, and soundTime. | |
| MP3LoaderVars | com.greensock.loading.data | Can be used instead of a generic Object to define the vars parameter of a MP3Loader's constructor. | |
| OnChangeRatioPlugin | com.greensock.plugins | [AS3/AS2 only] This plugin allows you to define a callback method that should be called whenever the tween's "ratio" property changes which effectively means that the tweening values changed. | |
| OnCompleteRenderPlugin | com.greensock.plugins | [AS3 only] Calls a function as soon as the tween completes AND the final frame actually renders to the screen. | |
| PathFollower | com.greensock.motionPaths | [AS3 only] A PathFollower is used to associate a particular target object (like a MovieClip, Point, Sprite, etc.) with a MotionPath and it offers a tweenable progress property that manages positioning the target on the path accordingly. | |
| Physics2DPlugin | com.greensock.plugins | Provides simple physics functionality for tweening an Object's x and y coordinates based on a combination of velocity, angle, gravity, acceleration, accelerationAngle, and/or friction. | |
| PhysicsPropsPlugin | com.greensock.plugins | Sometimes it's useful to tween a value at a particular velocity and/or acceleration without a specific end value in mind. | |
| PinPoint | com.greensock.layout | PinPoint works with LiquidStage to create reference points on the stage and/or inside DisplayObjects so that the movement of these PinPoints trickles down and affects the position of attached DisplayObjects. | |
| Positions2DPlugin | com.greensock.plugins | [AS3/AS2 only] This plugin allows you to define an array of Points at which the target should be positioned during the course of the tween (in order). | |
| Power0 | com.greensock.easing | Provides an easeIn, easeOut, and easeInOut with a power (or strength) of 0 which is identical to Linear but with a more intuitive name. | |
| Power1 | com.greensock.easing | Provides an easeIn, easeOut, and easeInOut with a power (or strength) of 1 which is identical to Quad but with a more intuitive name. | |
| Power2 | com.greensock.easing | Provides an easeIn, easeOut, and easeInOut with a power (or strength) of 2 which is identical to Cubic but with a more intuitive name. | |
| Power3 | com.greensock.easing | Provides an easeIn, easeOut, and easeInOut with a power (or strength) of 3 which is identical to Quart but with a more intuitive name. | |
| Power4 | com.greensock.easing | Provides an easeIn, easeOut, and easeInOut with a power (or strength) of 4 which is identical to Quint and Strong but with a more intuitive name. | |
| Quad | com.greensock.easing | Provides an easeIn, easeOut, and easeInOut with a power (or strength) of 1 which is identical to the Power1 ease. | |
| Quart | com.greensock.easing | Provides an easeIn, easeOut, and easeInOut with a power (or strength) of 2 which is identical to the Power2 ease. | |
| QuaternionsPlugin | com.greensock.plugins | [AS3/AS2 only] Performs SLERP interpolation between 2 Quaternions. | |
| Quint | com.greensock.easing | Provides an easeIn, easeOut, and easeInOut with a power (or strength) of 4 which is identical to the Power4 ease. | |
| RectanglePath2D | com.greensock.motionPaths | [AS3 only] A RectanglePath2D defines a rectangular path on which a PathFollower can be placed, making it simple to tween objects along a rectangle's perimeter. | |
| RemoveTintPlugin | com.greensock.plugins | [AS3/AS2 only] [deprecated in favor of tint:null] Removes the tint of a DisplayObject over time. | |
| RoughEase | com.greensock.easing | Most easing equations give a smooth, gradual transition between the start and end values, but RoughEase provides an easy way to get a rough, jagged effect instead, or you can also get an evenly-spaced back-and-forth movement if you prefer. | |
| RoundPropsPlugin | com.greensock.plugins | If you'd like the inbetween values in a tween to always get rounded to the nearest integer, use the roundProps special property. | |
| ScaleMode | com.greensock.layout | Provides constants for defining how objects should scale/stretch to fit within an area (like a LiquidArea or AutoFitArea). | |
| ScalePlugin | com.greensock.plugins | [AS3/AS2 only] ScalePlugin combines scaleX and scaleY into one "scale" property. | |
| ScrambleTextPlugin | com.greensock.plugins | Scrambles the text in a TextField with randomized characters (uppercase by default, but you can define lowercase or a set of custom characters), refreshing new randomized characters at regular intervals while gradually revealing your new text over the course of the tween (left to right). | |
| ScrollRectPlugin | com.greensock.plugins | [AS3/AS2 only] Tweens the scrollRect property of a DisplayObject. | |
| SelfLoader | com.greensock.loading | Tracks the loading progress of the swf in which the loader resides (basically a simple tool for tracking the loaderInfo's progress). | |
| SetActualSizePlugin | com.greensock.plugins | [AS3 only] Some components require resizing with setActualSize() instead of standard tweens of width/height in order to scale properly. | |
| SetSizePlugin | com.greensock.plugins | [AS3/AS2 only] Some components require resizing with setSize() instead of standard tweens of width/height in order to scale properly. | |
| ShortRotationPlugin | com.greensock.plugins | [AS3/AS2 only] To tween any rotation property of the target object in the shortest direction, use "shortRotation" For example, if myObject.rotation is currently 170 degrees and you want to tween it to -170 degrees, a normal rotation tween would travel a total of 340 degrees in the counter-clockwise direction, but if you use shortRotation, it would travel 20 degrees in the clockwise direction instead. | |
| SimpleTimeline | com.greensock.core | SimpleTimeline is the base class for TimelineLite and TimelineMax, providing the most basic timeline functionality and it is used for the root timelines in TweenLite but is only intended for internal use in the GreenSock tweening platform. | |
| Sine | com.greensock.easing | Eases with a relatively low power either at the beginning (easeIn), the end (easeOut), or both (easeInOut). | |
| SlowMo | com.greensock.easing | SlowMo is a configurable ease that produces a slow-motion effect that decelerates initially, then moves linearly for a certain portion of the ease (which you can choose) and then accelerates again at the end; it's great for effects like zooming text onto the screen, smoothly moving it long enough for people to read it, and then zooming it off the screen. | |
| SoundTransformPlugin | com.greensock.plugins | [AS3 only] Tweens properties of an object's soundTransform property (like the volume, pan, leftToRight, etc. | |
| SplitTextField | com.greensock.text | SplitTextField makes it easy to break apart a TextField so that each character, word, or line is in its own TextField, making complex animation simple. | |
| StageQualityPlugin | com.greensock.plugins | [AS3 only] Sets the stage's quality to a particular value during a tween and another value after the tween which can be useful for improving rendering performance in the Flash Player while things are animating. | |
| SteppedEase | com.greensock.easing | Most easing equations give a smooth, gradual transition between the start and end values, but SteppedEase provides an easy way to define a specific number of steps that the transition should take. | |
| Strong | com.greensock.easing | Provides an easeIn, easeOut, and easeInOut with a power (or strength) of 4 which is identical to the Power4 ease. | |
| SWFLoader | com.greensock.loading | Loads a swf file and automatically searches for active loaders in that swf that have the requireWithRoot vars property set to that swf's root. | |
| SWFLoaderVars | com.greensock.loading.data | Can be used instead of a generic object to define the vars parameter of an SWFLoader's constructor. | |
| ThrowPropsPlugin | com.greensock.plugins | ThrowPropsPlugin allows you to smoothly glide any property to a stop, honoring an initial velocity as well as applying optional restrictions on the end value. | |
| TimelineLite | com.greensock | TimelineLite is a powerful sequencing tool that acts as a container for tweens and other timelines, making it simple to control them as a whole and precisely manage their timing in relation to each other. | |
| TimelineMax | com.greensock | TimelineMax extends TimelineLite, offering exactly the same functionality plus useful (but non-essential) features like repeat, repeatDelay, yoyo, currentLabel(), addCallback(), removeCallback(), tweenTo(), tweenFromTo(), getLabelAfter(), getLabelBefore(), getActive(), AS3 event dispatching (and probably more in the future). | |
| TintPlugin | com.greensock.plugins | [AS3/AS2 only] To change a DisplayObject's tint/color, set this to the hex value of the tint you'd like to end up at (or begin at if you're using TweenMax.from()). | |
| TransformAroundCenterPlugin | com.greensock.plugins | [AS3/AS2 only] Normally, all transformations (scale, rotation, and position) are based on the DisplayObject's registration point (most often its upper left corner), but TransformAroundCenter allows you to make the 2D transformations occur around the DisplayObject's center. | |
| TransformAroundPointPlugin | com.greensock.plugins | [AS3/AS2 only] Normally, all transformations (scale, rotation, and position) are based on the DisplayObject's registration point (most often its upper left corner), but TransformAroundPoint allows you to define ANY point around which 2D transformations will occur during the tween. | |
| TransformMatrixPlugin | com.greensock.plugins | [AS3/AS2 only] TransformMatrixPlugin allows you to tween a DisplayObject's transform.matrix values directly (a, b, c, d, tx, and ty) or use common properties like x, y, scaleX, scaleY, skewX, skewY, rotation and even shortRotation. | |
| TweenEvent | com.greensock.events | Used for dispatching events from the GreenSock Animation Platform. | |
| TweenLite | com.greensock | TweenLite is an extremely fast, lightweight, and flexible animation tool that serves as the foundation of the GreenSock Animation Platform (GSAP), available in AS2, AS3, and JavaScript. | |
| TweenLiteVars | com.greensock.data | [AS3 only] There are 3 primary benefits of using a TweenLiteVars instance to define your TweenLite's "vars" parameter: In most code editors, code hinting will be activated which helps remind you which special properties are available. It allows you to code using strict data typing which can improve debugging. It will trace() a warning if you forgot to activate a particular plugin. | |
| TweenMax | com.greensock | TweenMax extends TweenLite, adding many useful (but non-essential) features like repeat(), repeatDelay(), yoyo(), AS3 event dispatching, updateTo(), pauseAll(), and more. | |
| TweenMaxVars | com.greensock.data | [AS3 only] There are 3 primary benefits of using a TweenMaxVars instance to define your TweenMax's "vars" parameter: In most code editors, code hinting will be activated which helps remind you which special properties are available. It allows you to code using strict data typing which can improve debugging. It will trace() a warning if you forgot to activate a particular plugin. | |
| TweenNano | com.greensock | [AS3/AS2 only] TweenNano is a super-lightweight (2k in AS3 and 2.6k in AS2) version of TweenLite and is only recommended for situations where you absolutely cannot afford the extra 4.7k that the normal TweenLite engine would cost and your project doesn't require any plugins. | |
| TweenPlugin | com.greensock.plugins | TweenPlugin is the base class for all TweenLite and TweenMax plugins, but generally isn't used directly. | |
| VelocityTracker | com.greensock.utils | Allows you to have the velocity of particular properties automatically tracked for you so that you can access them anytime using the VelocityTracker's getVelocity() method, like myTracker.getVelocity("y"). | |
| VideoLoader | com.greensock.loading | Loads an FLV, F4V, or MP4 video file using a NetStream and also provides convenient playback methods and properties like pauseVideo(), playVideo(), gotoVideoTime(), bufferProgress, playProgress, volume, duration, videoPaused, metaData, and videoTime. | |
| VideoLoaderVars | com.greensock.loading.data | Can be used instead of a generic Object to define the vars parameter of a VideoLoader's constructor. | |
| VisiblePlugin | com.greensock.plugins | [AS3/AS2 only] Toggles the visibility at the end of a tween. | |
| VolumePlugin | com.greensock.plugins | [AS3/AS2 only] Tweens the volume of an object with a soundTransform property (MovieClip/SoundChannel/NetStream, etc.). | |
| XMLLoader | com.greensock.loading | Loads an XML file and automatically searches it for LoaderMax-related nodes like <LoaderMax>, <ImageLoader>, <SWFLoader>, <XMLLoader>, <DataLoader> <CSSLoader>, <MP3Loader>, etc.; if it finds any, it will create the necessary instances and begin loading them if they have a load="true" attribute. | |
| XMLLoaderVars | com.greensock.loading.data | Can be used instead of a generic Object to define the vars parameter of a XMLLoader's constructor. |