| Package | verlocity.components |
| Class | public final class verSoundscape |
| Inheritance | verSoundscape  Component Singleton Object |
| Method | Defined By | ||
|---|---|---|---|
Constructor of the component. | verSoundscape | ||
_Destruct():void [override]
Destructor of the component. | verSoundscape | ||
 | _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 | |
GetName():String
Returns the current name of the soundscape
| verSoundscape | ||
Set(scNew:Soundscape):void
Sets the current soundscape. | verSoundscape | ||
Stop(bFade:Boolean = false):void
Stops the current soundscape
| verSoundscape | ||
| Method | Defined By | ||
|---|---|---|---|
| _Concommands():void
Called if verConsole is enabled, used to create concommands for the component. | Component | |
_Update():void [override]
Updates the soundscapes
| verSoundscape | ||
| verSoundscape | () | Constructor |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic function verSoundscape()Constructor of the component.
| _Destruct | () | method |
override public function _Destruct():voidDestructor of the component.
| _Update | () | method |
override protected function _Update():voidUpdates the soundscapes
| GetName | () | method |
public final function GetName():StringReturns the current name of the soundscape
ReturnsString —
|
| Set | () | method |
public final function Set(scNew:Soundscape):voidSets the current soundscape.
Parameters
scNew:Soundscape — The soundscape to set to
|
| Stop | () | method |
public final function Stop(bFade:Boolean = false):voidStops the current soundscape
Parameters
bFade:Boolean (default = false) |