| Package | verlocity.components |
| Class | public final class verPause |
| Inheritance | verPause  Component Singleton Object |
| Property | Defined By | ||
|---|---|---|---|
 | className : Object [read-only]
Returns the class name of the component for
dictionary registration. | Component | |
| MenuDisp : DisplayObject [read-only]
Returns the display object of the pause menu. | verPause | ||
| MenuGUI : PauseMenu [read-only]
Returns the pause menu gui element. | verPause | ||
| MenuList : Vector.<Array> [read-only]
Returns the list of pause menu items. | verPause | ||
| Method | Defined By | ||
|---|---|---|---|
verPause(sStage:Stage)
Constructor of the component. | verPause | ||
_Destruct():void [override]
Destructor of the component. | verPause | ||
| _IsNotUpdating():Boolean
Returns if the component is not updating (paused). | Component | |
| _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 | |
AddPauseMenuItem(sName:String, fFunction:Function):void
Adds a pause menu item
| verPause | ||
CanPause():Boolean
Returns if you can actually pause
| verPause | ||
ClearPauseMenuItems():void
Clears all pause menu items
| verPause | ||
Disable():void
Disables pausing
| verPause | ||
Enable():void
Enables pausing
| verPause | ||
IsPaused():Boolean
Returns if the engine is paused
| verPause | ||
IsPauseDisabled():Boolean
Returns if pause was disabled
| verPause | ||
Pause():void
Pauses everything
| verPause | ||
RemovePauseMenuItem(sName:String):void
Removes a pause menu item
| verPause | ||
Resume():void
Resumes everything
| verPause | ||
| Method | Defined By | ||
|---|---|---|---|
_Concommands():void [override]
Concommands of the component. | verPause | ||
| _Update():void
Called each engine tick (verEngine), if the component updates
| Component | |
| MenuDisp | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesMenuDisp:DisplayObject [read-only] Returns the display object of the pause menu.
public function get MenuDisp():DisplayObject| MenuGUI | property |
MenuGUI:PauseMenu [read-only] Returns the pause menu gui element.
public function get MenuGUI():PauseMenu| MenuList | property |
MenuList:Vector.<Array> [read-only] Returns the list of pause menu items.
public function get MenuList():Vector.<Array>| verPause | () | Constructor |
public function verPause(sStage:Stage)Constructor of the component.
ParameterssStage:Stage |
| _Concommands | () | method |
override protected function _Concommands():voidConcommands of the component.
| _Destruct | () | method |
override public function _Destruct():voidDestructor of the component.
| AddPauseMenuItem | () | method |
public final function AddPauseMenuItem(sName:String, fFunction:Function):voidAdds a pause menu item
Parameters
sName:String — Item name
| |
fFunction:Function — Function the button preforms
|
| CanPause | () | method |
public final function CanPause():BooleanReturns if you can actually pause
ReturnsBoolean —
|
| ClearPauseMenuItems | () | method |
public final function ClearPauseMenuItems():voidClears all pause menu items
| Disable | () | method |
public final function Disable():voidDisables pausing
| Enable | () | method |
public final function Enable():voidEnables pausing
| IsPaused | () | method |
public final function IsPaused():BooleanReturns if the engine is paused
ReturnsBoolean —
|
| IsPauseDisabled | () | method |
public final function IsPauseDisabled():BooleanReturns if pause was disabled
ReturnsBoolean —
|
| Pause | () | method |
public final function Pause():voidPauses everything
| RemovePauseMenuItem | () | method |
public final function RemovePauseMenuItem(sName:String):voidRemoves a pause menu item
Parameters
sName:String — Item name
|
| Resume | () | method |
public final function Resume():voidResumes everything