Barotrauma Client Doc
Barotrauma.BackgroundMusic Class Reference
Inheritance diagram for Barotrauma.BackgroundMusic:
Barotrauma.SoundPrefab Barotrauma.Prefab

Public Member Functions

 BackgroundMusic (ContentXElement element, SoundsFile file)
 
- Public Member Functions inherited from Barotrauma.SoundPrefab
 SoundPrefab (ContentXElement element, SoundsFile file, bool stream=false)
 
bool IsPlaying ()
 
override void Dispose ()
 
- Public Member Functions inherited from Barotrauma.Prefab
 Prefab (ContentFile file, Identifier identifier)
 
 Prefab (ContentFile file, ContentXElement element)
 

Public Attributes

readonly Identifier Type
 
readonly bool DuckVolume
 
readonly float Volume
 
readonly Vector2 IntensityRange
 
readonly bool MuteIntensityTracks
 
readonly? float ForceIntensityTrack
 
readonly bool StartFromRandomTime
 
readonly bool ContinueFromPreviousTime
 
int PreviousTime
 
- Public Attributes inherited from Barotrauma.SoundPrefab
readonly ContentPath SoundPath
 
readonly ContentXElement Element
 
readonly Identifier ElementName
 
- Public Attributes inherited from Barotrauma.Prefab
readonly Identifier Identifier
 
readonly ContentFile ContentFile
 

Static Public Attributes

static readonly PrefabCollection< BackgroundMusicBackgroundMusicPrefabs = new PrefabCollection<BackgroundMusic>()
 
- Static Public Attributes inherited from Barotrauma.SoundPrefab
static readonly PrefabSelector< SoundPrefabWaterAmbienceIn = new PrefabSelector<SoundPrefab>()
 
static readonly PrefabSelector< SoundPrefabWaterAmbienceOut = new PrefabSelector<SoundPrefab>()
 
static readonly PrefabSelector< SoundPrefabWaterAmbienceMoving = new PrefabSelector<SoundPrefab>()
 
static readonly PrefabSelector< SoundPrefabStartupSound = new PrefabSelector<SoundPrefab>()
 
static readonly ImmutableDictionary< Identifier, Type > TagToDerivedPrefab
 
static readonly PrefabCollection< SoundPrefabPrefabs
 
- Static Public Attributes inherited from Barotrauma.Prefab
static readonly ImmutableHashSet< Type > Types
 

Additional Inherited Members

- Static Public Member Functions inherited from Barotrauma.Prefab
static void DisallowCallFromConstructor ()
 
- Protected Member Functions inherited from Barotrauma.SoundPrefab
override Identifier DetermineIdentifier (XElement element)
 
- Properties inherited from Barotrauma.SoundPrefab
static IReadOnlyList< SoundPrefabFlowSounds [get]
 
static IReadOnlyList< SoundPrefabSplashSounds [get]
 
Sound Sound [get]
 
- Properties inherited from Barotrauma.Prefab
ContentPackageContentPackage [get]
 
ContentPath FilePath [get]
 

Detailed Description

Definition at line 232 of file SoundPrefab.cs.

Constructor & Destructor Documentation

◆ BackgroundMusic()

Barotrauma.BackgroundMusic.BackgroundMusic ( ContentXElement  element,
SoundsFile  file 
)

Definition at line 248 of file SoundPrefab.cs.

Member Data Documentation

◆ BackgroundMusicPrefabs

readonly PrefabCollection<BackgroundMusic> Barotrauma.BackgroundMusic.BackgroundMusicPrefabs = new PrefabCollection<BackgroundMusic>()
static

Definition at line 234 of file SoundPrefab.cs.

◆ ContinueFromPreviousTime

readonly bool Barotrauma.BackgroundMusic.ContinueFromPreviousTime

Definition at line 245 of file SoundPrefab.cs.

◆ DuckVolume

readonly bool Barotrauma.BackgroundMusic.DuckVolume

Definition at line 237 of file SoundPrefab.cs.

◆ ForceIntensityTrack

readonly? float Barotrauma.BackgroundMusic.ForceIntensityTrack

Definition at line 242 of file SoundPrefab.cs.

◆ IntensityRange

readonly Vector2 Barotrauma.BackgroundMusic.IntensityRange

Definition at line 240 of file SoundPrefab.cs.

◆ MuteIntensityTracks

readonly bool Barotrauma.BackgroundMusic.MuteIntensityTracks

Definition at line 241 of file SoundPrefab.cs.

◆ PreviousTime

int Barotrauma.BackgroundMusic.PreviousTime

Definition at line 246 of file SoundPrefab.cs.

◆ StartFromRandomTime

readonly bool Barotrauma.BackgroundMusic.StartFromRandomTime

Definition at line 244 of file SoundPrefab.cs.

◆ Type

readonly Identifier Barotrauma.BackgroundMusic.Type

Definition at line 236 of file SoundPrefab.cs.

◆ Volume

readonly float Barotrauma.BackgroundMusic.Volume

Definition at line 238 of file SoundPrefab.cs.