Packageverlocity.core
Classpublic class Component
InheritanceComponent Inheritance Singleton Inheritance Object
Subclasses ver3D, verAchievements, verBitmap, verCamera, verCollision, verConsole, verEngine, verEnts, verInput, verLayers, verParticles, verPause, verPhysics, verSave, verSound, verSoundAnalyzer, verSoundscape, verStates, verStats, verUI, verVariables


Public Properties
 PropertyDefined By
  className : Object
[read-only] Returns the class name of the component for dictionary registration.
Component
Protected Properties
 PropertyDefined By
  stage : Stage
Component
Public Methods
 MethodDefined By
  
Component(sStage:Stage = null, bUpdate:Boolean = false, bPauses:Boolean = false, bPauseOnStart:Boolean = false)
The constructor of a component.
Component
  
_Destruct():void
[override] Called when the component is destroyed.
Component
  
_IsNotUpdating():Boolean
Returns if the component is not updating (paused).
Component
 Inherited
_IsValid():Boolean
Returns if this singleton is active/valid.
Singleton
  
_SetUpdating(bUpdating:Boolean):void
Pauses/resumes the component updating, if it's pausable.
Component
  
_UpdateComponent():void
Updates the component, if possible.
Component
Protected Methods
 MethodDefined By
  
_Concommands():void
Called if verConsole is enabled, used to create concommands for the component.
Component
  
_Update():void
Called each engine tick (verEngine), if the component updates
Component
Property Detail
classNameproperty
className:Object  [read-only]

Returns the class name of the component for dictionary registration.


Implementation
    public function get className():Object
stageproperty 
protected var stage:Stage

Constructor Detail
Component()Constructor
public function Component(sStage:Stage = null, bUpdate:Boolean = false, bPauses:Boolean = false, bPauseOnStart:Boolean = false)

The constructor of a component.

Parameters
sStage:Stage (default = null) — The stage (to allow access to)
 
bUpdate:Boolean (default = false) — Update this component each frame (calls _Update)
 
bPauses:Boolean (default = false) — Can this component pause?
 
bPauseOnStart:Boolean (default = false) — Should this component be paused when first created?
Method Detail
_Concommands()method
protected function _Concommands():void

Called if verConsole is enabled, used to create concommands for the component.

_Destruct()method 
override public function _Destruct():void

Called when the component is destroyed.

_IsNotUpdating()method 
public function _IsNotUpdating():Boolean

Returns if the component is not updating (paused).

Returns
Boolean —
_SetUpdating()method 
public function _SetUpdating(bUpdating:Boolean):void

Pauses/resumes the component updating, if it's pausable.

Parameters

bUpdating:Boolean

_Update()method 
protected function _Update():void

Called each engine tick (verEngine), if the component updates

_UpdateComponent()method 
public function _UpdateComponent():void

Updates the component, if possible.





Wed Feb 29 2012, 07:04 PM -08:00