Table of Contents

Class CustomSoundSourceBase

Namespace
Nautilus.FMod
Assembly
Nautilus.dll
The base class used for loading sounds.
public abstract class CustomSoundSourceBase
Inheritance
CustomSoundSourceBase
Derived
Inherited Members
Extension Methods

Remarks

Used by the FModSoundBuilder to determine how it locates and loads its sounds.

Constructors

CustomSoundSourceBase(string)

The base constructor for a custom sound source.
protected CustomSoundSourceBase(string identifier)

Parameters

identifier string
Used for debugging and identification purposes.

Methods

GetAllCachedSounds()

Gets or creates a dictionary of all valid sound names.
protected Dictionary<string, CustomSoundSourceBase.CachedSound> GetAllCachedSounds()

Returns

Dictionary<string, CustomSoundSourceBase.CachedSound>
A dictionary that contains the name of every sound name. The key is the truncated 'name' of the sound, equivalent to Name.

InitializeCachedSounds()

Fetches the names of all valid sounds in the source. Is expected to only be called once.
protected abstract Dictionary<string, CustomSoundSourceBase.CachedSound> InitializeCachedSounds()

Returns

Dictionary<string, CustomSoundSourceBase.CachedSound>
Must return a list of all valid sound names.

ToString()

Returns the 'identifier' as determined by the constructor.
public override string ToString()

Returns

string