Packageorg.as3lib.kitchensync.action
Classpublic class AbstractActionGroup
InheritanceAbstractActionGroup Inheritance AbstractAction Inheritance flash.events.EventDispatcher
SubclassesKSParallelGroup, KSSequenceGroup



Public Properties
 PropertyDefined by
 InheritedautoDelete : Boolean
autoDelete is a flag that indicates whether the action should be killed when it is done executing.
AbstractAction
  childActions : Array
[read-only] An array containing all of the child actions of the group.
AbstractActionGroup
 Inheriteddelay : int
delay is the time that will pass after the start() method is called before the action begins.
AbstractAction
  duration : *
[write-only]
AbstractActionGroup
 InheriteddurationHasElapsed : Boolean
Checks to see whether the duration of the action has elapsed and if the _startTime is defined.
AbstractAction
 InheritedisInstantaneous : Boolean
Returns true if the action will occur instantaneously when started
AbstractAction
 InheritedisPaused : Boolean
Will return true if the action is paused (after pause() has been called).
AbstractAction
 InheritedisRunning : Boolean
The human-readable name of this action.
AbstractAction
 Inheritedoffset : int
legacy accessors.
AbstractAction
 InheritedpauseTime : Timestamp
The time at which the action was last paused.
AbstractAction
  resetChildrenAtStart : Boolean = true
If true, the group's KSTween children will reset to their default positions when the group is started.
AbstractActionGroup
 InheritedstartTime : Timestamp
The time at which the action was last started.
AbstractAction
 InheritedstartTimeHasElapsed : Boolean
Checks to see whether the start time delay has elapsed and if the _startTime is defined.
AbstractAction
 Inheritedsync : Boolean
Setting sync to true will cause the action to sync up with real time even if framerate drops.
AbstractAction
 InheritedtimeStringParser : ITimeStringParser
[static] The timeStringParser will determine how strings are parsed into valid time values.
AbstractAction
Protected Properties
 PropertyDefined by
 Inherited_autoDelete : Boolean
AbstractAction
  _childActions : Array
AbstractActionGroup
 Inherited_delay : int = 0
AbstractAction
 Inherited_duration : int = 0
AbstractAction
 Inherited_paused : Boolean = false
AbstractAction
 Inherited_pauseTime : Timestamp
AbstractAction
 Inherited_running : Boolean = false
AbstractAction
 Inherited_startTime : Timestamp
AbstractAction
 Inherited_sync : Boolean
AbstractAction
Public Methods
 MethodDefined by
  
Constructor.
AbstractActionGroup
  
addAction(action:IAction, ... additionalActions):void
Adds an action to the group.
AbstractActionGroup
  
addActionAtIndex(action:IAction, index:int = -1):void
Adds an action to the group at the specified index.
AbstractActionGroup
 Inherited
addEventTrigger(dispatcher:IEventDispatcher, eventType:String):void
Causes the action to start playing when a specified event is fired.
AbstractAction
 Inherited
addTrigger(trigger:IAction):void
Causes the action to start playing when another event completes.
AbstractAction
 Inherited
Creates a copy of the object with all the property values of the original and returns it.
AbstractAction
  
Returns the action at the specified index.
AbstractActionGroup
  
kill():void
AbstractActionGroup
  
pause():void
AbstractActionGroup
 Inherited
register():void
Adds the action as a listener to the Synchronizer's update event.
AbstractAction
  
Removes an action from the group.
AbstractActionGroup
  
Removes an action at the specified index.
AbstractActionGroup
 Inherited
removeEventTrigger(dispatcher:IEventDispatcher, eventType:String):void
Removes an event trigger added by addEventTrigger().
AbstractAction
 Inherited
removeTrigger(trigger:IAction):void
Removes a trigger added with addTrigger().
AbstractAction
  
Reverse the order that the children play back in.
AbstractActionGroup
  
AbstractActionGroup
  
stop():void
AbstractActionGroup
  
toString():String
AbstractActionGroup
  
unpause():void
AbstractActionGroup
 Inherited
unregister():void
Removes the action as a listener to the Synchronizer's update event.
AbstractAction
 Inherited
update(currentTimestamp:Timestamp):void
This function will be registered by the register method to respond to update events from the synchronizer.
AbstractAction
Protected Methods
 MethodDefined by
 Inherited
complete():void
Call this when the action has completed.
AbstractAction
 Inherited
forceUpdate():void
Foreces the update() method to fire without being triggered by Synchronizer.
AbstractAction
  
Called when child actions are completed.
AbstractActionGroup
  
Dispatches a CHILD_START event when the child begins.
AbstractActionGroup
 Inherited
onTrigger(event:Event):void
Handler that starts playing the action that is called by a trigger event.
AbstractAction
Events
 EventSummaryDefined by
 Inherited  AbstractAction
 Inherited  AbstractAction
 Inherited  AbstractAction
 Inherited  AbstractAction
    AbstractActionGroup
    AbstractActionGroup
Property detail
_childActionsproperty
protected var _childActions:Array
childActionsproperty 
childActions:Array  [read-only]

An array containing all of the child actions of the group.

Implementation
    public function get childActions():Array
durationproperty 
duration:*  [write-only]Implementation
    public function set duration(value:*):void
resetChildrenAtStartproperty 
public var resetChildrenAtStart:Boolean = true

If true, the group's KSTween children will reset to their default positions when the group is started.

Constructor detail
AbstractActionGroup()constructor
public function AbstractActionGroup()

Constructor.

Method detail
addAction()method
public function addAction(action:IAction, ... additionalActions):void

Adds an action to the group.

Parameters
action:IAction — - One or more actions to add to the group. Don't start this action. That will be handled by the group.
 
... additionalActions
addActionAtIndex()method 
public function addActionAtIndex(action:IAction, index:int = -1):void

Adds an action to the group at the specified index.

Parameters
action:IAction — - The action to add. Don't start this action. That will be handled by the group.
 
index:int (default = -1) — - The location at which to add the action. Defaults to the end of the Array
getChildAtIndex()method 
public function getChildAtIndex(index:int):IAction

Returns the action at the specified index.

Parameters
index:int — - The index in the array of the action to return.

Returns
IAction — The specified action.

Throws
— if the action cannot be found.
kill()method 
public override function kill():void
onChildFinished()method 
protected function onChildFinished(event:KitchenSyncEvent):void

Called when child actions are completed.

Parameters
event:KitchenSyncEvent — - The SynchronizerEvent.COMPLETE from the child action

Events
SynchronizerEvent.CHILD_COMPLETE
onChildStart()method 
protected function onChildStart(event:KitchenSyncEvent):void

Dispatches a CHILD_START event when the child begins.

Parameters
event:KitchenSyncEvent — - The SynchronizerEvent.START from the child action

Events
SynchronizerEvent.CHILD_START
pause()method 
public override function pause():void
removeAction()method 
public function removeAction(action:IAction):IAction

Removes an action from the group.

Parameters
action:IAction — - The action to remove.

Returns
IAction — The removed action.

Throws
— if the action cannot be found.
removeActionAtIndex()method 
public function removeActionAtIndex(index:int):IAction

Removes an action at the specified index.

Parameters
index:int — - The index in the array of the action to remove.

Returns
IAction — The removed action.

Throws
— if the action cannot be found.
reverseChildOrder()method 
public function reverseChildOrder():void

Reverse the order that the children play back in. Essentially, this just reverses the child array.

start()method 
public override function start():IAction

Returns
IAction
stop()method 
public override function stop():void
toString()method 
public override function toString():String

Returns
String
unpause()method 
public override function unpause():void
Event detail
childActionCompleteevent 
Event object type: org.as3lib.kitchensync.KitchenSyncEvent

childActionStartevent  
Event object type: org.as3lib.kitchensync.KitchenSyncEvent