| Package | org.as3lib.kitchensync.action |
| Class | public class KSStaggeredGroup |
| Inheritance | 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 | 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 | |
| stagger : int
Time to wait between the execution of each of the children.
| KSStaggeredGroup | ||
![]() | 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 | |
| _lastStartIndex : int | KSStaggeredGroup | ||
| _lastStartTime : Timestamp | KSStaggeredGroup | ||
![]() | _paused : Boolean = false | AbstractAction | |
![]() | _pauseTime : Timestamp | AbstractAction | |
![]() | _running : Boolean = false | AbstractAction | |
![]() | _runningChildren : int = 0 | KSParallelGroup | |
| _stagger : int | KSStaggeredGroup | ||
![]() | _startTime : Timestamp | AbstractAction | |
![]() | _sync : Boolean | AbstractAction | |
| Method | Defined by | ||
|---|---|---|---|
|
KSStaggeredGroup(stagger:*, ... children)
Constructor.
| KSStaggeredGroup | ||
![]() |
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 | |
| KSStaggeredGroup | |||
![]() |
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 | |
| KSStaggeredGroup | |||
![]() |
stop():void
| KSParallelGroup | |
|
toString():String
| KSStaggeredGroup | ||
![]() |
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.
| KSStaggeredGroup | ||
| _lastStartIndex | property |
protected var _lastStartIndex:int
| _lastStartTime | property |
protected var _lastStartTime:Timestamp
| _stagger | property |
protected var _stagger:int
| stagger | property |
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
| KSStaggeredGroup | () | constructor |
public function KSStaggeredGroup(stagger:*, ... children)Constructor.
Parametersstagger:* |
|
... children |
— - if any children are not of type AbstractSynchronizedAction.
|
| clone | () | method |
| start | () | method |
| 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 |