Packageorg.as3lib.kitchensync.action
Classpublic class KSStaggeredGroup
InheritanceKSStaggeredGroup Inheritance KSParallelGroup Inheritance AbstractActionGroup Inheritance AbstractAction Inheritance flash.events.EventDispatcher

A group of actions that executes in sequence seperated by a specified gap.



Public Properties
 PropertyDefined by
 InheritedautoDelete : Boolean
autoDelete is a flag that indicates whether the action should be killed when it is done executing.
AbstractAction
 InheritedchildActions : Array
An array containing all of the child actions of the group.
AbstractActionGroup
 InheritedchildrenAreRunning : Boolean
KSParallelGroup
 Inheriteddelay : int
delay is the time that will pass after the start() method is called before the action begins.
AbstractAction
 Inheritedduration : *
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
 InheritedresetChildrenAtStart : Boolean = true
If true, the group's KSTween children will reset to their default positions when the group is started.
AbstractActionGroup
  stagger : int
Time to wait between the execution of each of the children.
KSStaggeredGroup
 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
 Inherited_childActions : Array
AbstractActionGroup
 Inherited_delay : int = 0
AbstractAction
 Inherited_duration : int = 0
AbstractAction
  _lastStartIndex : int
KSStaggeredGroup
  _lastStartTime : Timestamp
KSStaggeredGroup
 Inherited_paused : Boolean = false
AbstractAction
 Inherited_pauseTime : Timestamp
AbstractAction
 Inherited_running : Boolean = false
AbstractAction
 Inherited_runningChildren : int = 0
KSParallelGroup
  _stagger : int
KSStaggeredGroup
 Inherited_startTime : Timestamp
AbstractAction
 Inherited_sync : Boolean
AbstractAction
Public Methods
 MethodDefined by
  
KSStaggeredGroup(stagger:*, ... children)
Constructor.
KSStaggeredGroup
 Inherited
addAction(action:IAction, ... additionalActions):void
Adds an action to the group.
AbstractActionGroup
 Inherited
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
  
KSStaggeredGroup
 Inherited
Returns the action at the specified index.
AbstractActionGroup
 Inherited
kill():void
AbstractActionGroup
 Inherited
pause():void
AbstractActionGroup
 Inherited
register():void
Adds the action as a listener to the Synchronizer's update event.
AbstractAction
 Inherited
Removes an action from the group.
AbstractActionGroup
 Inherited
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
 Inherited
Reverse the order that the children play back in.
AbstractActionGroup
  
KSStaggeredGroup
 Inherited
stop():void
KSParallelGroup
  
toString():String
KSStaggeredGroup
 Inherited
unpause():void
AbstractActionGroup
 Inherited
unregister():void
Removes the action as a listener to the Synchronizer's update event.
AbstractAction
  
update(currentTimestamp:Timestamp):void
When the first update occurs, all of the child actions are started simultaniously.
KSStaggeredGroup
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
 Inherited
Called when child actions are completed.
KSParallelGroup
 Inherited
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
 Inherited  AbstractActionGroup
 Inherited  AbstractActionGroup
Property detail
_lastStartIndexproperty
protected var _lastStartIndex:int
_lastStartTimeproperty 
protected var _lastStartTime:Timestamp
_staggerproperty 
protected var _stagger:int
staggerproperty 
stagger:int  [read-write]

Time to wait between the execution of each of the children. Accepts integer or parsable time string.

Implementation
    public function get stagger():int
    public function set stagger(value:int):void

See also

org.as3lib.kitchensync.ITimeStringParser;
Constructor detail
KSStaggeredGroup()constructor
public function KSStaggeredGroup(stagger:*, ... children)

Constructor.

Parameters
stagger:*
 
... children

Throws
— - if any children are not of type AbstractSynchronizedAction.
Method detail
clone()method
public override function clone():IAction

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

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

Returns
String
update()method 
public override function update(currentTimestamp:Timestamp):void

When the first update occurs, all of the child actions are started simultaniously.

Parameters
currentTimestamp:Timestamp