Packagecom.desuade.motion.bases
Classpublic class BaseBasic
InheritanceBaseBasic Inheritance flash.events.EventDispatcher
Subclasses BasicPhysics, BasicTween

Language Version : ActionScript 3
Since : 01.05.2009
Runtime Versions : AIR 1.0, Flash Player 9.0.0

The base class for Basic objects.



Public Properties
 PropertyDefined By
  active : Boolean
[read-only] If the primitive is currently active and running.
BaseBasic
  config : Object
[read-only] Gets the config object that was passed in the constructor.
BaseBasic
  pid : int
[read-only] The primitive's id
BaseBasic
  target : Object
The target object
BaseBasic
Public Methods
 MethodDefined By
  
BaseBasic(target:Object, configObject:Object = null)
This creates a new BaseBasic instance. The constructor accepts an object that has all the paramaters for the config.
BaseBasic
  
fromXML(xml:XML):*
Configures the object based on the values provided by the XML. Most properties can assigned in the attributes using the same names. The values of the attributes will be converted to Numbers if they're not NaN.
BaseBasic
  
start(delay:Number = -1, position:Number = -1):*
This starts and creates the primitive.
BaseBasic
  
stop():Boolean
This stops and removes the primitive.
BaseBasic
  
toXML():XML
This creates an XML object that represents the object, based on it's config object.
BaseBasic
Property Detail
activeproperty
active:Boolean  [read-only]

If the primitive is currently active and running.


Implementation
    public function get active():Boolean
configproperty 
config:Object  [read-only]

Gets the config object that was passed in the constructor. The properties in this object can be modified.


Implementation
    public function get config():Object
pidproperty 
pid:int  [read-only]

The primitive's id


Implementation
    public function get pid():int
targetproperty 
public var target:Object

The target object

Constructor Detail
BaseBasic()Constructor
public function BaseBasic(target:Object, configObject:Object = null)

This creates a new BaseBasic instance.

The constructor accepts an object that has all the paramaters for the config.

Parameters
target:Object — The target object
 
configObject:Object (default = null) — The config object that has all the values for the config
Method Detail
fromXML()method
public function fromXML(xml:XML):*

Configures the object based on the values provided by the XML.

Most properties can assigned in the attributes using the same names.

The values of the attributes will be converted to Numbers if they're not NaN. For values that should be Strings (for relative), use a '*' – ie: value='*50'

Parameters

xml:XML — The XML to use for configuration

Returns
* — The object that called the method (for chaining)
start()method 
public function start(delay:Number = -1, position:Number = -1):*

This starts and creates the primitive.

Parameters

delay:Number (default = -1)
 
position:Number (default = -1)

Returns
* — The object (for chaining)
stop()method 
public function stop():Boolean

This stops and removes the primitive.

Returns
Boolean — True if the primitive could be stopped.
toXML()method 
public function toXML():XML

This creates an XML object that represents the object, based on it's config object.

Returns
XML — An XML object of the config