Packageorg.as3lib.kitchensync
Classpublic final class KitchenSync

Gateway to the library. Initializes the entire system.

See also

org.as3lib.kitchensync.core.Synchronizer


Public Methods
 MethodDefined by
  
KitchenSync
  
initialize(frameRateSeed:DisplayObject, versionCheck:String):void
[static] Initializes the timing core for KitchenSync.
KitchenSync
Public Constants
 ConstantDefined by
  VERSION : String = "1.6"
[static] The current version of the library.
KitchenSync
Constructor detail
KitchenSync()constructor
public function KitchenSync()
Method detail
initialize()method
public static function initialize(frameRateSeed:DisplayObject, versionCheck:String):void

Initializes the timing core for KitchenSync. Must be called before using any actions.

Parameters
frameRateSeed:DisplayObject — must be a DisplayObject that is added to the display list.
 
versionCheck:String — a string for the version you think you're using. e.g. 1.2 This is recommended but not required. It will throw an error if you're using the wrong version of KS.
Constant detail
VERSIONconstant
public static const VERSION:String = "1.6"

The current version of the library. Use this to verify that the library is the version that your software expects.