| Package | org.as3lib.kitchensync.action |
| Class | public class AbstractActionGroup |
| Inheritance | AbstractActionGroup  AbstractAction flash.events.EventDispatcher |
| Subclasses | KSParallelGroup, KSSequenceGroup |
| Property | Defined by | ||
|---|---|---|---|
 | autoDelete : Boolean
autoDelete is a flag that indicates whether the action should be deleted
when it is done executing.
| AbstractAction | |
| childActions : Array [read-only]
An array containing all of the child actions of the group.
| AbstractActionGroup | ||
| delay : int
delay is the time that will pass after the start() method is called
before the action begins.
| AbstractAction | |
| duration : * [write-only]
| AbstractActionGroup | ||
| durationHasElapsed : Boolean
Checks to see whether the duration of the action has elapsed and if the _startTime is defined.
| AbstractAction | |
| isPaused : Boolean
Will return true if the action is paused (after pause() has been called).
| AbstractAction | |
| isRunning : Boolean
Will return true when the action is running (after start() has been called).
| AbstractAction | |
| name : String
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 | |
| 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 | |
| _name : String | AbstractAction | |
| _paused : Boolean = false | AbstractAction | |
| _pauseTime : Timestamp | AbstractAction | |
| _running : Boolean = false | AbstractAction | |
| _startTime : Timestamp | AbstractAction | |
| _sync : Boolean | AbstractAction | |
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| AbstractActionGroup | ||
|
addAction(action:AbstractAction, ... additionalActions):void
Adds an action to the group.
| AbstractActionGroup | ||
|
addActionAtIndex(action:AbstractAction, 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:AbstractAction):void
Causes the action to start playing when another event completes.
| AbstractAction | |
|
Creates a copy of the object with all the property values of the original and returns it.
| AbstractAction | |
|
getChildAtIndex(index:int):AbstractAction
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):AbstractAction
Removes an action at the specified index.
| AbstractActionGroup | ||
|
removeEventTrigger(dispatcher:IEventDispatcher, eventType:String):void
Removes an event trigger added by addEventTrigger().
| AbstractAction | |
|
removeTrigger(trigger:AbstractAction):void
Removes a trigger added with addTrigger().
| AbstractAction | |
|
reverseChildOrder():void
Reverse the order that the children play back in.
| AbstractActionGroup | ||
|
Starts the timer for this action.
| AbstractAction | |
|
stop():void
| AbstractActionGroup | ||
|
toString():String
| AbstractActionGroup | ||
|
unpause():void
| AbstractActionGroup | ||
|
unregister():void
Removes the action as a listener to the Synchronizer's update event.
| AbstractAction | |
| Method | Defined by | ||
|---|---|---|---|
|
complete():void
Call this when the action has completed.
| AbstractAction | |
|
forceUpdate():void
Foreces the onUpdate() method to fire without being triggered by Synchronizer.
| AbstractAction | |
|
onChildFinished(event:KitchenSyncEvent):void
Called when child actions are completed.
| AbstractActionGroup | ||
|
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 | |
|
onUpdate(event:KitchenSyncEvent):void
This function will be registered by the register method to respond to update events from the synchronizer.
| AbstractAction | |
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| AbstractAction | |||
| AbstractAction | |||
| AbstractAction | |||
| AbstractAction | |||
| AbstractActionGroup | ||||
| AbstractActionGroup | ||||
| _childActions | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _childActions:Array
| childActions | property |
childActions:Array [read-only]An array containing all of the child actions of the group.
Implementation public function get childActions():Array
| duration | property |
duration:* [write-only]Implementation
public function set duration(value:*):void
| AbstractActionGroup | () | constructor |
public function AbstractActionGroup()Constructor.
| addAction | () | method |
public function addAction(action:AbstractAction, ... additionalActions):voidAdds an action to the group.
Parametersaction:AbstractAction — - 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:AbstractAction, index:int = -1):voidAdds an action to the group at the specified index.
Parametersaction:AbstractAction — - The action to add. Don't start this action. That will be handled by the group.
|
|
index:int (default = -1) |
| getChildAtIndex | () | method |
public function getChildAtIndex(index:int):AbstractActionReturns the action at the specified index.
Parametersindex:int — - The index in the array of the action to return.
|
AbstractAction —
The specified action.
|
|
| kill | () | method |
public override function kill():void
| onChildFinished | () | method |
protected function onChildFinished(event:KitchenSyncEvent):voidCalled when child actions are completed.
Parametersevent:KitchenSyncEvent — - The SynchronizerEvent.COMPLETE from the child action
|
SynchronizerEvent.CHILD_COMPLETE
|
| onChildStart | () | method |
protected function onChildStart(event:KitchenSyncEvent):voidDispatches a CHILD_START event when the child begins.
Parametersevent:KitchenSyncEvent — - The SynchronizerEvent.START from the child action
|
SynchronizerEvent.CHILD_START
|
| pause | () | method |
public override function pause():void
| removeAction | () | method |
public function removeAction(action:AbstractAction):AbstractActionRemoves an action from the group.
Parametersaction:AbstractAction — - The action to remove.
|
AbstractAction —
The removed action.
|
|
| removeActionAtIndex | () | method |
public function removeActionAtIndex(index:int):AbstractActionRemoves an action at the specified index.
Parametersindex:int — - The index in the array of the action to remove.
|
AbstractAction —
The removed action.
|
|
| reverseChildOrder | () | method |
public function reverseChildOrder():voidReverse the order that the children play back in. Essentially, this just reverses the child array.
| stop | () | method |
public override function stop():void
| toString | () | method |
public override function toString():String
Returns
String |
| unpause | () | method |
public override function unpause():void
| childActionComplete | event |
| childActionStart | event |