AQFunction

Kind of class: public class
Package:
Inherits from:
  • none
Classpath: org.asaplibrary.util.actionqueue.AQFunction
File last modified: Wednesday, 11 May 2011, 18:53:27
Action method to call a function repeatedly over time, with a changing numeric value.

Summary

Instance methods
  • call (inCallFunction:Function, inDuration:Number, inStartValue:Number, inEndValue:Number, inEffect:Function = null) : Function
    • Calls function inCallFunction over a period of time, with a start value changing to an end value.
  • callDynamic (inCallFunction:Function, inDuration:Number, inCallStartValueFunction:Function, inEndValue:Number, inEffect:Function = null) : Function
    • Like call, but the start value is now being looked up just before the action starts (using inCallStartValueFunction).

Instance methods

call

function call(inCallFunction:Function, inDuration:Number, inStartValue:Number, inEndValue:Number, inEffect:Function = null) : Function

Calls function inCallFunction over a period of time, with a start value changing to an end value. The function should accept 1 numeric value.

Parameters
inCallFunction:function to call
inDuration :length of change in seconds; 0 is used for perpetual animations - use -1 for instant change
inStartValue :the start value to call inCallFunction with
inEndValue :the end value to call inCallFunction with
inEffect :(optional) an effect function, for instance one of the fl.transitions.easing methods
Example
  • This queue calls function setHeight for a duration of 2 seconds with a value between getCurrentHeight() and the projected tContent.height. If no effect is applied, setHeight will be half the projected height at 1 second: 
    var queue:ActionQueue = new ActionQueue();
queue.addAction(new AQFunction().call(setHeight, 2.0, getCurrentHeight(), tContent.height));
queue.run();
Returns

callDynamic

function callDynamic(inCallFunction:Function, inDuration:Number, inCallStartValueFunction:Function, inEndValue:Number, inEffect:Function = null) : Function

Like call, but the start value is now being looked up just before the action starts (using inCallStartValueFunction).

Parameters
inCallFunction :function to call
inDuration :length of change in seconds; 0 is used for perpetual animations - use -1 for instant change
inCallStartValueFunction:the function that will return the the start value to call inCallFunction with
inEndValue :the end value to call inCallFunction with
inEffect :(optional) an effect function, for instance one of the fl.motion.easing methods