Packageverlocity.components
Classpublic final class verConsole
InheritanceverConsole Inheritance Component Inheritance Singleton Inheritance Object

In-game debugging console with real-time stat display and logging. The console supports registering console commands. In order to enable the console, you must first enable Settings.DEBUG


Public Properties
 PropertyDefined By
 InheritedclassName : Object
[read-only] Returns the class name of the component for dictionary registration.
Component
Protected Properties
 PropertyDefined By
 Inheritedstage : Stage
Component
Public Methods
 MethodDefined By
  
verConsole(sStage:Stage)
Constructor of the component.
verConsole
  
_Destruct():void
[override] Destructor of the component.
verConsole
 Inherited
_IsNotUpdating():Boolean
Returns if the component is not updating (paused).
Component
 Inherited
_IsValid():Boolean
Returns if this singleton is active/valid.
Singleton
 Inherited
_SetUpdating(bUpdating:Boolean):void
Pauses/resumes the component updating, if it's pausable.
Component
 Inherited
_UpdateComponent():void
Updates the component, if possible.
Component
  
IsActive():Boolean
Returns if the console is active/displaying.
verConsole
  
Output(sOutput:String):void
Outputs a string into the console window.
verConsole
  
Register(sCommand:String, fFunction:Function, sDesc:String):void
Registers a concommand
verConsole
Protected Methods
 MethodDefined By
 Inherited
_Concommands():void
Called if verConsole is enabled, used to create concommands for the component.
Component
 Inherited
_Update():void
Called each engine tick (verEngine), if the component updates
Component
Constructor Detail
verConsole()Constructor
public function verConsole(sStage:Stage)

Constructor of the component.

Parameters
sStage:Stage
Method Detail
_Destruct()method
override public function _Destruct():void

Destructor of the component.

IsActive()method 
public final function IsActive():Boolean

Returns if the console is active/displaying.

Returns
Boolean
Output()method 
public final function Output(sOutput:String):void

Outputs a string into the console window. Use Verlocity.Trace for expanded features.

Parameters

sOutput:String — The string to output.

Register()method 
public final function Register(sCommand:String, fFunction:Function, sDesc:String):void

Registers a concommand

Parameters

sCommand:String — The concommand
 
fFunction:Function — The function to preform
 
sDesc:String — The description of the concommand (for the help function)





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