new Tweener()
static public function addTween(p_scopes:Object, p_parameters:Object):Boolean
Adds a new tweening
Boolean TRUE if the tween was successfully added, FALSE if otherwise
static public function addCaller(p_scopes:Object, p_parameters:Object):Boolean
Adds a new *caller* tweening
Boolean TRUE if the tween was successfully added, FALSE if otherwise
static public function removeTweensByTime(p_scope:Object, p_properties:Object, p_timeStart:Number, p_timeComplete:Number):Boolean
Remove an specified tweening of a specified object the tweening list, if it conflicts with the given time
p_scope | Object List of objects affected |
p_properties | Object List of properties affected (PropertyInfoObj instances) |
p_timeStart | Number Time when the new tween starts |
p_timeComplete | Number Time when the new tween ends |
Boolean Whether or not it actually deleted something
static public function removeTweens(p_scope:Object):Boolean
Remove tweenings from a given object from the tweening list
Boolean Whether or not it successfully removed this tweening
static public function removeAllTweens():Boolean
Remove all tweenings from the engine
Boolean Whether or not it successfully removed a tweening
static public function pauseTweens(p_scope:Object):Boolean
Pause tweenings from a given object
p_scope | Object Object that must have its tweens paused |
Boolean Whether or not it successfully paused something
static public function pauseAllTweens():Boolean
Pause all tweenings on the engine
Boolean Whether or not it successfully paused a tweening
static public function resumeTweens(p_scope:Object):Boolean
Resume tweenings from a given object
p_scope | Object Object that must have its tweens resumed |
Boolean Whether or not it successfully resumed something
static public function resumeAllTweens():Boolean
Resume all tweenings on the engine
Boolean Whether or not it successfully resumed a tweening
static public function splitTweens(p_tween:Number, p_properties:Array):Number
Splits a tweening in two
p_tween | Number Object that must have its tweens split |
p_properties | Array Array of strings containing the list of properties that must be separated |
Number The index number of the new tween
static public function removeTweenByIndex(p_tween:Number, p_finalRemoval:Boolean):Boolean
Remove an specific tweening from the tweening list
p_tween | Number Index of the tween to be removed on the tweenings list |
Boolean Whether or not it successfully removed this tweening
static public function pauseTweenByIndex(p_tween:Number):Boolean
Pauses an specific tween
p_tween | Number Index of the tween to be paused |
Boolean Whether or not it successfully paused this tweening
static public function resumeTweenByIndex(p_tween:Number):Boolean
Resumes an specific tween
p_tween | Number Index of the tween to be resumed |
Boolean Whether or not it successfully resumed this tweening
static public function registerTransition(p_name:String, p_function:Function):Void
Adds a new function to the available transition list "shortcuts"
p_name | String Shorthand transition name |
p_function | Function The proper equation function |
static public function registerSpecialProperty(p_name:String, p_getFunction:Function, p_setFunction:Function, p_parameters:Array, p_preProcessFunction:Function):Void
Adds a new special property to the available special property list.
p_name | Name of the "special" property. |
p_getFunction | Function that gets the value. |
p_setFunction | Function that sets the value. |
static public function registerSpecialPropertyModifier(p_name:String, p_modifyFunction:Function, p_getFunction:Function):Void
Adds a new special property modifier to the available modifier list.
p_name | Name of the "special" property modifier. |
p_modifyFunction | Function that modifies the value. |
p_getFunction | Function that gets the value. |
static public function registerSpecialPropertySplitter(p_name:String, p_splitFunction:Function, p_parameters:Array):Void
Adds a new special property splitter to the available splitter list.
p_name | Name of the "special" property splitter. |
p_splitFunction | Function that splits the value. |
static public function updateTime():Void
Updates the time to enforce time grid-based updates
static public function onEnterFrame():Void
Ran once every frame. It's the main engine, updates all existing tweenings.
static public function setTimeScale(p_time:Number):Void
Sets the new time scale.
p_time | Number New time scale (0.5 = slow, 1 = normal, 2 = 2x fast forward, etc) |
static public function isTweening(p_scope:Object):Boolean
Finds whether or not an object has any tweening
p_scope | Object Target object |
Boolean Whether or not there's a tweening occuring on this object (paused, delayed, or active)
static public function getTweens(p_scope:Object):Array
Return an array containing a list of the properties being tweened for this object
p_scope | Object Target object |
Array List of strings with properties being tweened (including delayed or paused)
static public function getTweenCount(p_scope:Object):Number
Return the number of properties being tweened for this object
p_scope | Object Target object |
Number Total count of properties being tweened (including delayed or paused)
static public function getCurrentTweeningTime(p_tweening:Object):Number
Get the current tweening time (no matter if it uses frames or time as basis), given a specific tweening
p_tweening | TweenListObj Tween information |
static public function getVersion():String
Return the current tweener version
String The number of the current Tweener version