org.as3lib.kitchensync.action.KSStepedSequenceGroup

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

A sequence that plays each child then pauses until it is started again. Perfect for slideshow or powerpoint-like applications.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	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	KSSequenceGroup
		currentAction : IAction	KSSequenceGroup
		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

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined by
		_autoDelete : Boolean	AbstractAction
		_childActions : Array	AbstractActionGroup
		_currentAction : IAction = null	KSSequenceGroup
		_currentActionIndex : int = -1	KSSequenceGroup
		_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
		_waitingForInput : Boolean = false Used internally to determine whether the next item should play or whether the children should simply be unpaused when the unpause() method is called.	KSStepedSequenceGroup

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		KSStepedSequenceGroup(... children) Constructor.	KSStepedSequenceGroup
		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	KSSequenceGroup
		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 Override start to automatically quit if there are no children.	KSSequenceGroup
		stop():void	AbstractActionGroup
		toString():String	KSSequenceGroup
		unpause():void Override unpause to see if the sequence was paused internally or externally.	KSStepedSequenceGroup
		unregister():void Removes the action as a listener to the Synchronizer's update event.	AbstractAction
		update(currentTimestamp:Timestamp):void Listens for updates to synchronize the start time of the sequence.	KSSequenceGroup

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined by
		checkForComplete():Boolean Checks to see if all of the children have completed.	KSSequenceGroup
		complete():void override to reset the _currentActionIndex.	KSSequenceGroup
		forceUpdate():void Foreces the update() method to fire without being triggered by Synchronizer.	AbstractAction
		onChildFinished(event:KitchenSyncEvent):void Override the onChildFinished handler to pause the sequence after each child completes.	KSStepedSequenceGroup
		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
		startNextAction():IAction Starts playing the next action in the sequence.	KSSequenceGroup

Events

Hide Inherited Events

Show Inherited Events

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

Protected Constants

Hide Inherited Protected Constants

Show Inherited Protected Constants

	Constant		Defined by
		NO_CURRENT_ACTION_INDEX : int = -1	KSSequenceGroup

Property detail

_waitingForInput

property

protected var _waitingForInput:Boolean = false

Used internally to determine whether the next item should play or whether the children should simply be unpaused when the unpause() method is called.

Constructor detail

KSStepedSequenceGroup

()

constructor

public function KSStepedSequenceGroup(... children)

Constructor. Identical to KSSequenceGroup.

Parameters

... children — Optional children to add upon instantiation.

Method detail

onChildFinished

()

method

protected override function onChildFinished(event:KitchenSyncEvent):void

Override the onChildFinished handler to pause the sequence after each child completes.

Parameters

event:KitchenSyncEvent

unpause

()

method

public override function unpause():void

Override unpause to see if the sequence was paused internally or externally.

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