org.as3lib.kitchensync.action.KSAsynchronousFunction

Public Properties

	Property		Defined by
		autoDelete : Boolean autoDelete is a flag that indicates whether the action should be deleted when it is done executing.	AbstractAction
		delay : int delay is the time that will pass after the start() method is called before the action begins.	AbstractAction
		duration : *	KSFunction
		durationHasElapsed : Boolean Checks to see whether the duration of the action has elapsed and if the _startTime is defined.	AbstractAction
		func : Function The function that will be called by the action.	KSFunction
		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
		result : * The result of the function (if the function generates one.	KSFunction
		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
		_args : Array Arguments that will be passed into the function.	KSFunction
		_autoDelete : Boolean	AbstractAction
		_completeEventDispatcher : IEventDispatcher	KSAsynchronousFunction
		_completeEventType : String	KSAsynchronousFunction
		_delay : int = 0	AbstractAction
		_duration : int = 0	AbstractAction
		_func : Function	KSFunction
		_name : String	AbstractAction
		_paused : Boolean = false	AbstractAction
		_pauseTime : Timestamp	AbstractAction
		_result : *	KSFunction
		_running : Boolean = false	AbstractAction
		_startTime : Timestamp	AbstractAction
		_sync : Boolean	AbstractAction

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		KSAsynchronousFunction(delay:*, func:Function, completeEventDispatcher:IEventDispatcher, completeEventType:String, ... args)	KSAsynchronousFunction
		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
		clone():AbstractAction	KSAsynchronousFunction
		invoke():* Calls the function with the arguments specified.	KSFunction
		kill():void	KSAsynchronousFunction
		pause():void Causes the action to be paused.	AbstractAction
		register():void Adds the action as a listener to the Synchronizer's update event.	AbstractAction
		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
		start():AbstractAction Starts the timer for this action.	AbstractAction
		stop():void Stops the action from running and resets the timer.	AbstractAction
		unpause():void Resumes the action at the point where it was paused.	AbstractAction
		unregister():void Removes the action as a listener to the Synchronizer's update event.	AbstractAction

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	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
		onFunctionComplete(event:Event):void Event listener that is called when the asyncronous function is completed.	KSAsynchronousFunction
		onTrigger(event:Event):void Handler that starts playing the action that is called by a trigger event.	AbstractAction
		onUpdate(event:KitchenSyncEvent):void Executes the function when the delay has elapsed.	KSAsynchronousFunction

Property detail

_completeEventDispatcher

property

protected var _completeEventDispatcher:IEventDispatcher

_completeEventType

property

protected var _completeEventType:String

Constructor detail

KSAsynchronousFunction

()

constructor

public function KSAsynchronousFunction(delay:*, func:Function, completeEventDispatcher:IEventDispatcher, completeEventType:String, ... args)

Parameters

	`delay:*`

	`func:Function`

	`completeEventDispatcher:IEventDispatcher`

	`completeEventType:String`

	`... args`

Method detail

clone

()

method

public override function clone():AbstractAction

Returns

AbstractAction

kill

()

method

public override function kill():void

onFunctionComplete

()

method

protected function onFunctionComplete(event:Event):void

Event listener that is called when the asyncronous function is completed.

Parameters

event:Event

onUpdate

()

method

protected override function onUpdate(event:KitchenSyncEvent):void

Executes the function when the delay has elapsed.

Parameters

event:KitchenSyncEvent

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

Package	org.as3lib.kitchensync.action
Class	public class KSAsynchronousFunction
Inheritance	KSAsynchronousFunction KSFunction AbstractAction flash.events.EventDispatcher

	Event		Summary	Defined by
		actionComplete		AbstractAction
		actionPause		AbstractAction
		actionStart		AbstractAction
		actionUnpause		AbstractAction