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

Public Member Functions

 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 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 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
 

Protected Member Functions

override Identifier DetermineIdentifier (XElement element)
 

Properties

static IReadOnlyList< SoundPrefabFlowSounds [get]
 
static IReadOnlyList< SoundPrefabSplashSounds [get]
 
Sound Sound [get]
 
- Properties inherited from Barotrauma.Prefab
ContentPackageContentPackage [get]
 
ContentPath FilePath [get]
 

Additional Inherited Members

- Static Public Member Functions inherited from Barotrauma.Prefab
static void DisallowCallFromConstructor ()
 

Detailed Description

Definition at line 25 of file SoundPrefab.cs.

Constructor & Destructor Documentation

◆ SoundPrefab()

Barotrauma.SoundPrefab.SoundPrefab ( ContentXElement  element,
SoundsFile  file,
bool  stream = false 
)

Definition at line 188 of file SoundPrefab.cs.

Member Function Documentation

◆ DetermineIdentifier()

override Identifier Barotrauma.SoundPrefab.DetermineIdentifier ( XElement  element)
protectedvirtual

Reimplemented from Barotrauma.Prefab.

Definition at line 154 of file SoundPrefab.cs.

◆ Dispose()

override void Barotrauma.SoundPrefab.Dispose ( )
virtual

Implements Barotrauma.Prefab.

Definition at line 201 of file SoundPrefab.cs.

◆ IsPlaying()

bool Barotrauma.SoundPrefab.IsPlaying ( )

Definition at line 196 of file SoundPrefab.cs.

Member Data Documentation

◆ Element

readonly ContentXElement Barotrauma.SoundPrefab.Element

Definition at line 184 of file SoundPrefab.cs.

◆ ElementName

readonly Identifier Barotrauma.SoundPrefab.ElementName

Definition at line 185 of file SoundPrefab.cs.

◆ Prefabs

readonly PrefabCollection<SoundPrefab> Barotrauma.SoundPrefab.Prefabs
static

Definition at line 88 of file SoundPrefab.cs.

◆ SoundPath

readonly ContentPath Barotrauma.SoundPrefab.SoundPath

Definition at line 183 of file SoundPrefab.cs.

◆ StartupSound

readonly PrefabSelector<SoundPrefab> Barotrauma.SoundPrefab.StartupSound = new PrefabSelector<SoundPrefab>()
static

Definition at line 77 of file SoundPrefab.cs.

◆ TagToDerivedPrefab

readonly ImmutableDictionary<Identifier, Type> Barotrauma.SoundPrefab.TagToDerivedPrefab
static

Definition at line 84 of file SoundPrefab.cs.

◆ WaterAmbienceIn

readonly PrefabSelector<SoundPrefab> Barotrauma.SoundPrefab.WaterAmbienceIn = new PrefabSelector<SoundPrefab>()
static

Definition at line 74 of file SoundPrefab.cs.

◆ WaterAmbienceMoving

readonly PrefabSelector<SoundPrefab> Barotrauma.SoundPrefab.WaterAmbienceMoving = new PrefabSelector<SoundPrefab>()
static

Definition at line 76 of file SoundPrefab.cs.

◆ WaterAmbienceOut

readonly PrefabSelector<SoundPrefab> Barotrauma.SoundPrefab.WaterAmbienceOut = new PrefabSelector<SoundPrefab>()
static

Definition at line 75 of file SoundPrefab.cs.

Property Documentation

◆ FlowSounds

IReadOnlyList<SoundPrefab> Barotrauma.SoundPrefab.FlowSounds
staticget

Definition at line 80 of file SoundPrefab.cs.

◆ Sound

Sound Barotrauma.SoundPrefab.Sound
get

Definition at line 186 of file SoundPrefab.cs.

◆ SplashSounds

IReadOnlyList<SoundPrefab> Barotrauma.SoundPrefab.SplashSounds
staticget

Definition at line 82 of file SoundPrefab.cs.