Property | Defined By | ||
---|---|---|---|
a3D : ver3D [static] [read-only] | Verlocity | ||
achievements : verAchievements [static] [read-only] | Verlocity | ||
analyzer : verSoundAnalyzer [static] [read-only] | Verlocity | ||
bitmap : verBitmap [static] [read-only] | Verlocity | ||
camera : verCamera [static] [read-only] | Verlocity | ||
collision : verCollision [static] [read-only] | Verlocity | ||
console : verConsole [static] [read-only] | Verlocity | ||
ContentFolder : String [static] [read-only]
Returns the content folder. | Verlocity | ||
display : DisplayManager [static] [read-only]
Returns the display manager. | Verlocity | ||
engine : verEngine [static] [read-only] | Verlocity | ||
ents : verEnts [static] [read-only] | Verlocity | ||
game : Game [static] [read-only]
Returns the active game. | Verlocity | ||
gameLayer : String [static] [read-only]
Returns the string reference of the game layer. | Verlocity | ||
input : verInput [static] [read-only] | Verlocity | ||
keys : KeyManager [static] [read-only]
Returns the key manager. | Verlocity | ||
lang : LanguageManager [static] [read-only]
Returns the language manager, which allows for translation. | Verlocity | ||
layers : verLayers [static] [read-only] | Verlocity | ||
message : MessageManager [static] [read-only]
Returns the HUD message manager. | Verlocity | ||
particles : verParticles [static] [read-only] | Verlocity | ||
pause : verPause [static] [read-only] | Verlocity | ||
phys : verPhysics [static] [read-only] | Verlocity | ||
player : * [static] [read-only]
Returns the reference to the player entity. | Verlocity | ||
save : verSave [static] [read-only] | Verlocity | ||
ScrCenter : Point [static] [read-only]
Returns the global stage center point. | Verlocity | ||
ScrH : int [static] [read-only]
Returns the global stage height (resolution). | Verlocity | ||
ScrW : int [static] [read-only]
Returns the global stage width (resolution). | Verlocity | ||
settings : SettingsData [static] [read-only]
Returns Verlocity's settings. | Verlocity | ||
sound : verSound [static] [read-only] | Verlocity | ||
soundscape : verSoundscape [static] [read-only] | Verlocity | ||
state : verStates [static] [read-only] | Verlocity | ||
stats : verStats [static] [read-only] | Verlocity | ||
ui : verUI [static] [read-only] | Verlocity | ||
vars : verVariables [static] [read-only] | Verlocity |
Method | Defined By | ||
---|---|---|---|
Verlocity(sStage:Stage, sSettings:SettingsData = null)
Creates the Verlocity engine. | Verlocity | ||
_Destruct():void
Remove this singleton from the manager. | Singleton | ||
_IsValid():Boolean
Returns if this singleton is active/valid. | Singleton | ||
CleanSlate(bRemoveProtected:Boolean = false, bFadeOutSound:Boolean = false, bClearBitmapAssets:Boolean = false):void [static]
Clears all component objects. | Verlocity | ||
CurTime():int [static]
Returns the elapsed running time of the application. | Verlocity | ||
EndGame():void [static]
Ends the active game. | Verlocity | ||
IsComponentLoaded(comp:*):Boolean [static]
Returns if the component is currently loaded. | Verlocity | ||
IsQuitting():Boolean [static]
Returns if Verlocity is quitting. | Verlocity | ||
IsValid(obj:Object):Boolean [static]
Returns if an object is valid (checks for IsValid function). | Verlocity | ||
Key(sKeyName:String):uint [static]
Returns the key code based on a registered key name. | Verlocity | ||
Quit():void [static]
Completely removes and closes Verlocity and its components. | Verlocity | ||
ResetSlate(bStopSounds:Boolean = true):void [static]
Resets all component objects. | Verlocity | ||
RestartGame():void [static]
Restarts the active game. | Verlocity | ||
[static]
Sets the game. | Verlocity | ||
SetGameLayer(sLayer:String):void [static]
Sets a reference of the game layer. | Verlocity | ||
SetPlayer(playerEnt:*):void [static]
Sets a reference to the player (can be an entity). | Verlocity | ||
Trace(sTrace:String, sCaller:String = null):void [static]
Traces a debug message into the console. | Verlocity | ||
TraceError(sError:String, sCaller:String = null):void [static]
Traces an error. | Verlocity |
a3D | property |
achievements | property |
achievements:verAchievements
[read-only] public static function get achievements():verAchievements
analyzer | property |
analyzer:verSoundAnalyzer
[read-only] public static function get analyzer():verSoundAnalyzer
bitmap | property |
camera | property |
collision | property |
collision:verCollision
[read-only] public static function get collision():verCollision
console | property |
ContentFolder | property |
ContentFolder:String
[read-only] Returns the content folder.
public static function get ContentFolder():String
display | property |
display:DisplayManager
[read-only] Returns the display manager.
public static function get display():DisplayManager
engine | property |
ents | property |
game | property |
game:Game
[read-only] Returns the active game.
public static function get game():Game
gameLayer | property |
gameLayer:String
[read-only] Returns the string reference of the game layer.
public static function get gameLayer():String
input | property |
keys | property |
keys:KeyManager
[read-only] Returns the key manager.
public static function get keys():KeyManager
lang | property |
lang:LanguageManager
[read-only] Returns the language manager, which allows for translation.
public static function get lang():LanguageManager
layers | property |
message | property |
message:MessageManager
[read-only] Returns the HUD message manager.
public static function get message():MessageManager
particles | property |
particles:verParticles
[read-only] public static function get particles():verParticles
pause | property |
phys | property |
player | property |
player:*
[read-only] Returns the reference to the player entity.
public static function get player():*
save | property |
ScrCenter | property |
ScrCenter:Point
[read-only] Returns the global stage center point.
public static function get ScrCenter():Point
ScrH | property |
ScrH:int
[read-only] Returns the global stage height (resolution).
public static function get ScrH():int
ScrW | property |
ScrW:int
[read-only] Returns the global stage width (resolution).
public static function get ScrW():int
settings | property |
settings:SettingsData
[read-only] Returns Verlocity's settings.
public static function get settings():SettingsData
sound | property |
soundscape | property |
soundscape:verSoundscape
[read-only] public static function get soundscape():verSoundscape
state | property |
stats | property |
ui | property |
vars | property |
Verlocity | () | Constructor |
public function Verlocity(sStage:Stage, sSettings:SettingsData = null)
Creates the Verlocity engine.
ParameterssStage:Stage — The stage
| |
sSettings:SettingsData (default = null ) — Settings data (if none specified, will use defaults)
|
CleanSlate | () | method |
public static function CleanSlate(bRemoveProtected:Boolean = false, bFadeOutSound:Boolean = false, bClearBitmapAssets:Boolean = false):void
Clears all component objects. Very useful for clearing an entire scene for level changes.
Parameters
bRemoveProtected:Boolean (default = false ) — Remove protected objects?
| |
bFadeOutSound:Boolean (default = false ) — Fade out the sound?
| |
bClearBitmapAssets:Boolean (default = false ) — Remove all bitmap assets?
|
CurTime | () | method |
public static function CurTime():int
Returns the elapsed running time of the application. Uses verEngine, if loaded, otherwise defaults to native getTimer().
Returnsint —
|
EndGame | () | method |
public static function EndGame():void
Ends the active game.
IsComponentLoaded | () | method |
public static function IsComponentLoaded(comp:*):Boolean
Returns if the component is currently loaded.
Parameters
comp:* |
Boolean |
IsQuitting | () | method |
public static function IsQuitting():Boolean
Returns if Verlocity is quitting.
ReturnsBoolean |
IsValid | () | method |
public static function IsValid(obj:Object):Boolean
Returns if an object is valid (checks for IsValid function).
Parameters
obj:Object — Object to check if valid (checks IsValid function).
|
Boolean —
|
Key | () | method |
public static function Key(sKeyName:String):uint
Returns the key code based on a registered key name.
Parameters
sKeyName:String — The key name
|
uint —
|
Quit | () | method |
public static function Quit():void
Completely removes and closes Verlocity and its components. When you quit out of Verlocity, make sure you're not doing anything else with it in the following update scope, as it will cause an error. When in doubt, follow Quit with a return.
ResetSlate | () | method |
public static function ResetSlate(bStopSounds:Boolean = true):void
Resets all component objects.
Parameters
bStopSounds:Boolean (default = true )
|
RestartGame | () | method |
public static function RestartGame():void
Restarts the active game.
SetGame | () | method |
public static function SetGame(gSetGame:Game):void
Sets the game.
Parameters
gSetGame:Game — The game to set to.
|
SetGameLayer | () | method |
public static function SetGameLayer(sLayer:String):void
Sets a reference of the game layer. You can get this with Verlocity.gameLayer
Parameters
sLayer:String |
SetPlayer | () | method |
public static function SetPlayer(playerEnt:*):void
Sets a reference to the player (can be an entity). You can get this with Verlocity.player
Parameters
playerEnt:* |
Trace | () | method |
public static function Trace(sTrace:String, sCaller:String = null):void
Traces a debug message into the console. Only available when VerlocitySettings.DEBUG is on.
Parameters
sTrace:String — The message to trace.
| |
sCaller:String (default = null ) — The caller of the trace (optional).
|
TraceError | () | method |
public static function TraceError(sError:String, sCaller:String = null):void
Traces an error. This will create a notification icon in the bottom left.
Parameters
sError:String — The error message to display
| |
sCaller:String (default = null ) — The caller of the error message (optional).
|