org.as3lib.kitchensync.action.KSSetProperty

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

SynchronizedAction to set a property for any object to a specified value.

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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		KSSetProperty(target:Object, key:String, value:, delay: = 0)	KSSetProperty
		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	KSFunction
		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

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 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
		setProperty(target:Object, key:String, value:*):void This is the function that will be called to set the property.	KSSetProperty

Events

Hide Inherited Events

Show Inherited Events

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

Constructor detail

KSSetProperty

()

constructor

public function KSSetProperty(target:Object, key:String, value:*, delay:* = 0)

Parameters

	`target:Object` — - The object whose property you want to modify.

	`key:String` — - The name of the property to modify.

	`value:*` — - The new value of the property.

	`delay:*` (default = `0`) — - The delay before the action executes.

Method detail

setProperty

()

method

protected function setProperty(target:Object, key:String, value:*):void

This is the function that will be called to set the property.

Parameters

	`target:Object`

	`key:String`

	`value:*`