| Package | org.as3lib.kitchensync.action |
| Class | public class KSParallelGroup |
| Inheritance | KSParallelGroup  AbstractActionGroup AbstractAction flash.events.EventDispatcher |
| Subclasses | KSSimultaneousEndGroup, KSStaggeredGroup |
| Property | Defined by | ||
|---|---|---|---|
 | autoDelete : Boolean
autoDelete is a flag that indicates whether the action should be killed
when it is done executing.
| AbstractAction | |
| childActions : Array
An array containing all of the child actions of the group.
| AbstractActionGroup | |
| childrenAreRunning : Boolean [read-only]
| KSParallelGroup | ||
| delay : int
delay is the time that will pass after the start() method is called
before the action begins.
| AbstractAction | |
| duration : * | AbstractActionGroup | |
| durationHasElapsed : Boolean
Checks to see whether the duration of the action has elapsed and if the _startTime is defined.
| AbstractAction | |
| isInstantaneous : Boolean Returns true if the action will occur instantaneously when started
| AbstractAction | |
| isPaused : Boolean
Will return true if the action is paused (after pause() has been called).
| AbstractAction | |
| isRunning : Boolean
The human-readable name of this action.
| AbstractAction | |
| offset : int
legacy accessors.
| AbstractAction | |
| pauseTime : 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 | |
| startTime : Timestamp
The time at which the action was last started.
| AbstractAction | |
| startTimeHasElapsed : Boolean
Checks to see whether the start time delay has elapsed and if the _startTime is defined.
| AbstractAction | |
| sync : Boolean
Setting sync to true will cause the action to sync up with real time
even if framerate drops.
| AbstractAction | |
| timeStringParser : ITimeStringParser
[static]
The timeStringParser will determine how strings are parsed into valid
time values.
| AbstractAction | |
| Property | Defined by | ||
|---|---|---|---|
| _autoDelete : Boolean | AbstractAction | |
| _childActions : Array | AbstractActionGroup | |
| _delay : int = 0 | AbstractAction | |
| _duration : int = 0 | AbstractAction | |
| _paused : Boolean = false | AbstractAction | |
| _pauseTime : Timestamp | AbstractAction | |
| _running : Boolean = false | AbstractAction | |
| _runningChildren : int = 0 | KSParallelGroup | ||
| _startTime : Timestamp | AbstractAction | |
| _sync : Boolean | AbstractAction | |
| Method | Defined by | ||
|---|---|---|---|
|
KSParallelGroup(... children)
Constructor.
| KSParallelGroup | ||
|
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 | |
|
addEventTrigger(dispatcher:IEventDispatcher, eventType:String):void
Causes the action to start playing when a specified event is fired.
| AbstractAction | |
|
addTrigger(trigger:IAction):void
Causes the action to start playing when another event completes.
| AbstractAction | |
| KSParallelGroup | |||
|
getChildAtIndex(index:int):IAction
Returns the action at the specified index.
| AbstractActionGroup | |
|
kill():void
| AbstractActionGroup | |
|
pause():void
| AbstractActionGroup | |
|
register():void
Adds the action as a listener to the Synchronizer's update event.
| AbstractAction | |
|
Removes an action from the group.
| AbstractActionGroup | |
|
removeActionAtIndex(index:int):IAction
Removes an action at the specified index.
| AbstractActionGroup | |
|
removeEventTrigger(dispatcher:IEventDispatcher, eventType:String):void
Removes an event trigger added by addEventTrigger().
| AbstractAction | |
|
removeTrigger(trigger:IAction):void
Removes a trigger added with addTrigger().
| AbstractAction | |
|
reverseChildOrder():void
Reverse the order that the children play back in.
| AbstractActionGroup | |
| AbstractActionGroup | ||
|
stop():void
| KSParallelGroup | ||
|
toString():String
| KSParallelGroup | ||
|
unpause():void
| AbstractActionGroup | |
|
unregister():void
Removes the action as a listener to the Synchronizer's update event.
| AbstractAction | |
|
When the first update occurs, all of the child actions are started simultaniously.
| KSParallelGroup | ||
| Method | Defined by | ||
|---|---|---|---|
|
complete():void
Call this when the action has completed.
| AbstractAction | |
|
forceUpdate():void
Foreces the update() method to fire without being triggered by Synchronizer.
| AbstractAction | |
|
onChildFinished(event:KitchenSyncEvent):void
Called when child actions are completed.
| KSParallelGroup | ||
|
onChildStart(event:KitchenSyncEvent):void
Dispatches a CHILD_START event when the child begins.
| AbstractActionGroup | |
|
onTrigger(event:Event):void
Handler that starts playing the action that is called by a trigger event.
| AbstractAction | |
| childrenAreRunning | property |
Hide Inherited Public Properties
Show Inherited Public PropertieschildrenAreRunning:Boolean [read-only]Implementation
public function get childrenAreRunning():Boolean
| _runningChildren | property |
protected var _runningChildren:int = 0
| KSParallelGroup | () | constructor |
public function KSParallelGroup(... children)Constructor.
Parameters... children |
|
| clone | () | method |
| onChildFinished | () | method |
protected override function onChildFinished(event:KitchenSyncEvent):voidCalled when child actions are completed. After each is finished, checks to see if the entire set is complete. If not, it waits for the next child. Completed children are removed from the array so they can be garbage collected.
Parametersevent:KitchenSyncEvent — - The SynchronizerEvent.COMPLETE
|
| stop | () | method |
public override function stop():void
| toString | () | method |
public override function toString():String
Returns
String |
| update | () | method |
public override function update(currentTimestamp:Timestamp):voidWhen the first update occurs, all of the child actions are started simultaniously.
ParameterscurrentTimestamp:Timestamp |