| Package | org.as3lib.kitchensync.action |
| Class | public class KSWait |
| Inheritance | KSWait  AbstractAction flash.events.EventDispatcher |
| 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 : * [write-only]
| KSWait | ||
| durationHasElapsed : Boolean
Checks to see whether the duration of the action has elapsed and if the _startTime is defined.
| AbstractAction | |
| 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 | |
| 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 | |
| waitTime : int Time that the action will wait.
| KSWait | ||
| Method | Defined by | ||
|---|---|---|---|
|
KSWait(waitTime:*)
Constructor.
| KSWait | ||
|
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 | |
| KSWait | |||
|
kill():void
Unregisters the function and removes any refrerences to objects that it may be holding onto.
| AbstractAction | |
|
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 | |
|
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 | |
| 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 | |
|
onTrigger(event:Event):void
Handler that starts playing the action that is called by a trigger event.
| AbstractAction | |
|
onUpdate(event:KitchenSyncEvent):void
| KSWait | ||
| duration | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesduration:* [write-only]Implementation
public function set duration(value:*):void
| waitTime | property |
waitTime:int [read-write]Time that the action will wait. Synonym for delay.
Implementation public function get waitTime():int
public function set waitTime(value:int):void
| KSWait | () | constructor |
public function KSWait(waitTime:*)Constructor.
ParameterswaitTime:* — Time that the action will wait.
|
| clone | () | method |
| onUpdate | () | method |