org.as3lib.kitchensync.action.AbstractActionGroup

	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 [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
		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
		_startTime : Timestamp	AbstractAction
		_sync : Boolean	AbstractAction

Public Methods

	Method		Defined by
		AbstractActionGroup() 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
		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
		clone():IAction Creates a copy of the object with all the property values of the original and returns it.	AbstractAction
		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
		removeAction(action:IAction):IAction 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
		start():IAction	AbstractActionGroup
		stop():void	AbstractActionGroup
		toString():String	AbstractActionGroup
		unpause():void	AbstractActionGroup
		unregister():void Removes the action as a listener to the Synchronizer's update event.	AbstractAction
		update(currentTimestamp:Timestamp):void This function will be registered by the register method to respond to update events from the synchronizer.	AbstractAction

	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.	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

Property detail

_childActions

property

protected 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

resetChildrenAtStart

property

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

childActionComplete

event

Event object type: org.as3lib.kitchensync.KitchenSyncEvent

childActionStart

event

Event object type: org.as3lib.kitchensync.KitchenSyncEvent

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class AbstractActionGroup	Properties \| Methods \| Events

Package	org.as3lib.kitchensync.action
Class	public class AbstractActionGroup
Inheritance	AbstractActionGroup AbstractAction flash.events.EventDispatcher
Subclasses	KSParallelGroup, KSSequenceGroup

	Event		Summary	Defined by
		actionComplete		AbstractAction
		actionPause		AbstractAction
		actionStart		AbstractAction
		actionUnpause		AbstractAction
		childActionComplete		AbstractActionGroup
		childActionStart		AbstractActionGroup