ActionRunner

Kind of class: public class
Package:
Inherits from:
  • EventDispatcher
Implements:
Classpath: org.asaplibrary.util.actionqueue.ActionRunner
File last modified: Wednesday, 11 May 2011, 18:51:34
Sequentially calls a list of Action objects. Each action is performed one after the other. ActionRunner is used by ActionQueue, but can be used on its own. Actions are objects of type Action, IAction, TimedAction or ITimedAction or any subclass thereof.
Events broadcasted to listeners

Summary

Instance methods
  • isRunning () : Boolean
  • setActions (inActions:Array) : void
    • Sets the list of actions.
  • addActions (inActions:Array) : void
    • Adds a list of actions to the existing list.
  • addAction (inAction:IAction) : void
    • Add an Action to the existing list of actions.
  • insertAction (inAction:IAction) : void
    • Inserts an action just before the current position.
  • insertActionAtIndex (inIndex:uint, inAction:IAction) : void
    • Inserts an Action at a specific position in the list of actions.
  • run () : *
    • Starts running the actions.
  • pause (inContinueWhereLeftOff:Boolean = true) : void
    • Pauses the runner.
  • stop () : void
    • Stops the runner, but does not clear the action list.
  • isFinished () : Boolean
  • isPaused () : Boolean
  • getActions () : Array
    • The list of actions.
  • quit () : void
    • Quits the runner and clears the list of actions.
  • reset () : void
    • Clears the action list.
  • resume () : void
    • Resumes a paused runner.
  • getName () : String
    • The name of this runner.
  • skip () : void
    • Skips the pointer to the action by one.
  • gotoStep (inIndex:int) : void
    • Sets the index of the current step.

Instance methods

addAction

function addAction(inAction:IAction) : void

Add an Action to the existing list of actions.

addActions

function addActions(inActions:Array) : void

Adds a list of actions to the existing list.

getActions

function getActions() : Array

The list of actions.

getName

function getName() : String

The name of this runner.

gotoStep

function gotoStep(inIndex:int) : void

Sets the index of the current step. The index is zero-based, so the first action has step index 0.

insertAction

function insertAction(inAction:IAction) : void

Inserts an action just before the current position.

insertActionAtIndex

function insertActionAtIndex(inIndex:uint, inAction:IAction) : void

Inserts an Action at a specific position in the list of actions.

isFinished

function isFinished() : Boolean
Returns
  • True if the runner has run through all actions; otherwise false.

isPaused

function isPaused() : Boolean
Returns
  • True if the runner has been paused; otherwise false.

isRunning

function isRunning() : Boolean
Returns
  • True is the ActionRunner is running actions; false if it is stopped or finished. A paused but running runner will return true.

pause

function pause(inContinueWhereLeftOff:Boolean = true) : void

Pauses the runner.

Parameters
inContinueWhereLeftOff:(optional) whether the Action should continue where it left off when the runner is resumed
Events broadcasted to listeners

quit

function quit() : void

Quits the runner and clears the list of actions.

Events broadcasted to listeners

reset

function reset() : void

Clears the action list.

resume

function resume() : void

Resumes a paused runner.

Events broadcasted to listeners

run

function run() : *

Starts running the actions.

Returns
  • null
Events broadcasted to listeners

setActions

function setActions(inActions:Array) : void

Sets the list of actions.

Parameters
inAction:the list of Actions to set

stop

function stop() : void

Stops the runner, but does not clear the action list.

Events broadcasted to listeners