org.as3lib.kitchensync.action.KSActionController

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

Executes a function within another AbstractSynchronizedAction when executed. This allows you to easily control other actions within a sequence. The accepted commands can be found in ActionControllerCommands.

See also

ActionControllerCommands

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
		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
		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
		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
		target : IAction	KSActionController
		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
		_delay : int = 0	AbstractAction
		_duration : int = 0	AbstractAction
		_func : Function	KSFunction
		_paused : Boolean = false	AbstractAction
		_pauseTime : Timestamp	AbstractAction
		_result : *	KSFunction
		_running : Boolean = false	AbstractAction
		_startTime : Timestamp	AbstractAction
		_sync : Boolean	AbstractAction
		_target : IAction The action that the ActionController will send commands to.	KSActionController

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		KSActionController(target:IAction, command:ActionControllerCommand = null, delay:* = 0) Constructor.	KSActionController
		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	KSFunction
		invoke():* Calls the function with the arguments specified.	KSFunction
		kill():void	KSActionController
		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:IAction):void Removes a trigger added with addTrigger().	AbstractAction
		start():IAction 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
		update(currentTimestamp:Timestamp):void Executes the function when the delay has elapsed.	KSFunction

	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
		onTrigger(event:Event):void Handler that starts playing the action that is called by a trigger event.	AbstractAction

Property detail

_target

property

protected var _target:IAction

The action that the ActionController will send commands to.

target

property

target:IAction  [read-write]Implementation
    public function get target():IAction
    public function set target(value:IAction):void

Constructor detail

KSActionController

()

constructor

public function KSActionController(target:IAction, command:ActionControllerCommand = null, delay:* = 0)

Constructor.

Parameters

	`target:IAction` — - the AbstractSynchronizedAction that will receive the commands from the controller.

	`command:ActionControllerCommand` (default = `null`) — - the function that the SynchronizedAction will perform when the ActionController executes.

	`delay:*` (default = `0`) — - the number of frames to delay the action.

Method detail

kill

()

method

public override function kill():void

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

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