Packageorg.as3lib.kitchensync.action
Interfacepublic interface IAction extends ISynchronizerClient, flash.events.IEventDispatcher
SubinterfacesITween
ImplementorsAbstractAction, KSSimpleTween

An action is a type that represents any kind of happening that takes place at a certain time.


Public Properties
 PropertyDefined by
  delay : int
delay is the time that will pass after the start() method is called before the action begins.
IAction
  duration : int
duration is the length of time that the action will run.
IAction
  isPaused : Boolean
[read-only] Should return true if the action is paused.
IAction
  isRunning : Boolean
[read-only] Should return true if the action is running (or paused).
IAction
Public Methods
 MethodDefined by
  
clone():IAction
Returns an exact copy of the action.
IAction
  
kill():void
Unregisters the action and removes any refrerences to objects that it may be holding onto.
IAction
  
pause():void
Causes the action to be paused.
IAction
  
start():IAction
Starts the timer for this action.
IAction
  
stop():void
Stops the action from running and resets the timer.
IAction
  
unpause():void
Resumes the action at the point where it was paused.
IAction
 Inherited
update(currentTimestamp:Timestamp):void
Update will allow the synchronizer to update the action with the current time.
ISynchronizerClient
Property detail
delayproperty
delay:int  [read-write]

delay is the time that will pass after the start() method is called before the action begins. Uses to allow use of time string parser.

Implementation
    public function get delay():int
    public function set delay(value:int):void
durationproperty 
duration:int  [read-write]

duration is the length of time that the action will run. Uses to allow use of time string parser.

Implementation
    public function get duration():int
    public function set duration(value:int):void
isPausedproperty 
isPaused:Boolean  [read-only]

Should return true if the action is paused.

Implementation
    public function get isPaused():Boolean
isRunningproperty 
isRunning:Boolean  [read-only]

Should return true if the action is running (or paused).

Implementation
    public function get isRunning():Boolean
Method detail
clone()method
public function clone():IAction

Returns an exact copy of the action.

Returns
IAction
kill()method 
public function kill():void

Unregisters the action and removes any refrerences to objects that it may be holding onto.

pause()method 
public function pause():void

Causes the action to be paused. The action temporarily ignores update events from the Synchronizer and the onUpdate() handler will not be called. When unpause() is called, the action will continue at the point where it was paused. The pause() method affects the start time even if the delay time hasn't expired yet.

start()method 
public function start():IAction

Starts the timer for this action.

Returns
IAction — The action that was just started for convenience.
stop()method 
public function stop():void

Stops the action from running and resets the timer.

unpause()method 
public function unpause():void

Resumes the action at the point where it was paused.