Packageorg.as3lib.kitchensync.action
Classpublic class KSMovieClipController
InheritanceKSMovieClipController Inheritance KSFunction Inheritance AbstractAction Inheritance flash.events.EventDispatcher

Tells a target MovieClip to play a specified frame.



Public Properties
 PropertyDefined by
 InheritedautoDelete : Boolean
autoDelete is a flag that indicates whether the action should be killed when it is done executing.
AbstractAction
 Inheriteddelay : int
delay is the time that will pass after the start() method is called before the action begins.
AbstractAction
 Inheritedduration : *
KSFunction
 InheriteddurationHasElapsed : Boolean
Checks to see whether the duration of the action has elapsed and if the _startTime is defined.
AbstractAction
  frameIdentifier : *
KSMovieClipController
 Inheritedfunc : Function
The function that will be called by the action.
KSFunction
 InheritedisInstantaneous : Boolean
Returns true if the action will occur instantaneously when started
AbstractAction
 InheritedisPaused : Boolean
Will return true if the action is paused (after pause() has been called).
AbstractAction
 InheritedisRunning : Boolean
The human-readable name of this action.
AbstractAction
 Inheritedoffset : int
legacy accessors.
AbstractAction
 InheritedpauseTime : Timestamp
The time at which the action was last paused.
AbstractAction
 Inheritedresult : *
The result of the function (if the function generates one.
KSFunction
 InheritedstartTime : Timestamp
The time at which the action was last started.
AbstractAction
 InheritedstartTimeHasElapsed : Boolean
Checks to see whether the start time delay has elapsed and if the _startTime is defined.
AbstractAction
 Inheritedsync : Boolean
Setting sync to true will cause the action to sync up with real time even if framerate drops.
AbstractAction
  target : MovieClip
KSMovieClipController
 InheritedtimeStringParser : ITimeStringParser
[static] The timeStringParser will determine how strings are parsed into valid time values.
AbstractAction
Protected Properties
 PropertyDefined by
 Inherited_args : Array
Arguments that will be passed into the function.
KSFunction
 Inherited_autoDelete : Boolean
AbstractAction
 Inherited_delay : int = 0
AbstractAction
 Inherited_duration : int = 0
AbstractAction
  _frameIdentifier : *
A frame identifier could be a string or a frame number to play
KSMovieClipController
 Inherited_func : Function
KSFunction
 Inherited_paused : Boolean = false
AbstractAction
 Inherited_pauseTime : Timestamp
AbstractAction
 Inherited_result : *
KSFunction
 Inherited_running : Boolean = false
AbstractAction
 Inherited_startTime : Timestamp
AbstractAction
 Inherited_sync : Boolean
AbstractAction
  _target : MovieClip
KSMovieClipController
Public Methods
 MethodDefined by
  
KSMovieClipController(delay:*, target:MovieClip, frameIdentifier:*)
Constructor.
KSMovieClipController
 Inherited
addEventTrigger(dispatcher:IEventDispatcher, eventType:String):void
Causes the action to start playing when a specified event is fired.
AbstractAction
 Inherited
addTrigger(trigger:IAction):void
Causes the action to start playing when another event completes.
AbstractAction
  
KSMovieClipController
 Inherited
invoke():*
Calls the function with the arguments specified.
KSFunction
 Inherited
kill():void
KSFunction
 Inherited
pause():void
Causes the action to be paused.
AbstractAction
 Inherited
register():void
Adds the action as a listener to the Synchronizer's update event.
AbstractAction
 Inherited
removeEventTrigger(dispatcher:IEventDispatcher, eventType:String):void
Removes an event trigger added by addEventTrigger().
AbstractAction
 Inherited
removeTrigger(trigger:IAction):void
Removes a trigger added with addTrigger().
AbstractAction
 Inherited
Starts the timer for this action.
AbstractAction
 Inherited
stop():void
Stops the action from running and resets the timer.
AbstractAction
 Inherited
unpause():void
Resumes the action at the point where it was paused.
AbstractAction
 Inherited
unregister():void
Removes the action as a listener to the Synchronizer's update event.
AbstractAction
 Inherited
update(currentTimestamp:Timestamp):void
Executes the function when the delay has elapsed.
KSFunction
Protected Methods
 MethodDefined by
 Inherited
complete():void
Call this when the action has completed.
AbstractAction
 Inherited
forceUpdate():void
Foreces the update() method to fire without being triggered by Synchronizer.
AbstractAction
 Inherited
onTrigger(event:Event):void
Handler that starts playing the action that is called by a trigger event.
AbstractAction
Events
 EventSummaryDefined by
 Inherited  AbstractAction
 Inherited  AbstractAction
 Inherited  AbstractAction
 Inherited  AbstractAction
Property detail
_frameIdentifierproperty
protected var _frameIdentifier:*

A frame identifier could be a string or a frame number to play

frameIdentifierproperty 
frameIdentifier:*  [read-write]Implementation
    public function get frameIdentifier():*
    public function set frameIdentifier(value:*):void
_targetproperty 
protected var _target:MovieClip
targetproperty 
target:MovieClip  [read-write]Implementation
    public function get target():MovieClip
    public function set target(value:MovieClip):void
Constructor detail
KSMovieClipController()constructor
public function KSMovieClipController(delay:*, target:MovieClip, frameIdentifier:*)

Constructor.

Parameters
delay:* — - the number of frames to delay the action
 
target:MovieClip — - the MovieClip whose frames you are going to
 
frameIdentifier:* — - a String or uint to go to
Method detail
clone()method
public override function clone():IAction

Returns
IAction