Baldi's Basics Plus Glue API
Modding API for Baldi's Basics Plus
Loading...
Searching...
No Matches
BBPGlue.API.BBPSoundObject Class Referencesealed

Wrapper around a sound object providing access to clip, mixing, and subtitle settings. More...

Public Member Functions

 BBPSoundObject (object? raw)
 Initializes a new instance of the BBPSoundObject class wrapping a raw object.

Properties

bool AddToMemory [get, set]
 Gets or sets whether this sound should be added to memory for later playback.
AudioClip? Clip [get, set]
 Gets or sets the primary audio clip for the sound object.
AudioClip?[] Clips [get, set]
 Gets or sets the set of audio clips usable by this sound object.
Color Color [get, set]
 Gets or sets the color used for subtitles or visual indicators for this sound.
bool Encrypted [get, set]
 Gets or sets whether the sound data is encrypted.
bool Exists [get]
 Determines whether the underlying raw object exists.
bool HasAnimation [get, set]
 Gets or sets whether this sound has an associated animation.
bool IsLoopingSoundObject [get]
 Gets whether the wrapped object is a looping sound object type.
string Key [get, set]
 Gets or sets the sound key used for identification or localization lookup.
AudioClip? LocalizedClip [get]
 Gets the localized audio clip if available.
bool LockSettings [get, set]
 Gets or sets whether settings for this sound are locked from modification.
AudioMixerGroup? Mixer [get, set]
 Gets or sets the mixer group used for this sound.
AudioMixerGroup? MixerOverride [get, set]
 Gets or sets an optional mixer group override for the sound.
object? Raw [get]
 The raw underlying sound object wrapped by this API class, or null if none.
object? SoundType [get, set]
 Gets or sets the sound type enum/value associated with the sound.
bool Subtitle [get, set]
 Gets or sets whether subtitles should be displayed for this sound.
float SubtitleDuration [get, set]
 Gets or sets the duration for subtitles associated with this sound.
float VolumeMultiplier [get, set]
 Gets or sets the volume multiplier applied to this sound.

Detailed Description

Wrapper around a sound object providing access to clip, mixing, and subtitle settings.

Constructor & Destructor Documentation

◆ BBPSoundObject()

BBPGlue.API.BBPSoundObject.BBPSoundObject ( object? raw)

Initializes a new instance of the BBPSoundObject class wrapping a raw object.

Parameters
rawThe raw underlying object instance or null.

Property Documentation

◆ AddToMemory

bool BBPGlue.API.BBPSoundObject.AddToMemory
getset

Gets or sets whether this sound should be added to memory for later playback.

Returns
True if added to memory; otherwise false.

◆ Clip

AudioClip? BBPGlue.API.BBPSoundObject.Clip
getset

Gets or sets the primary audio clip for the sound object.

Returns
The AudioClip or null.

◆ Clips

AudioClip? [] BBPGlue.API.BBPSoundObject.Clips
getset

Gets or sets the set of audio clips usable by this sound object.

Returns
An array of AudioClip or null.

◆ Color

Color BBPGlue.API.BBPSoundObject.Color
getset

Gets or sets the color used for subtitles or visual indicators for this sound.

Returns
The Color value.

◆ Encrypted

bool BBPGlue.API.BBPSoundObject.Encrypted
getset

Gets or sets whether the sound data is encrypted.

Returns
True if encrypted; otherwise false.

◆ Exists

bool BBPGlue.API.BBPSoundObject.Exists
get

Determines whether the underlying raw object exists.

◆ HasAnimation

bool BBPGlue.API.BBPSoundObject.HasAnimation
getset

Gets or sets whether this sound has an associated animation.

Returns
True if an animation exists; otherwise false.

◆ IsLoopingSoundObject

bool BBPGlue.API.BBPSoundObject.IsLoopingSoundObject
get

Gets whether the wrapped object is a looping sound object type.

Returns
True if the underlying type name equals "LoopingSoundObject"; otherwise false.

◆ Key

string BBPGlue.API.BBPSoundObject.Key
getset

Gets or sets the sound key used for identification or localization lookup.

Returns
The sound key as a string.

◆ LocalizedClip

AudioClip? BBPGlue.API.BBPSoundObject.LocalizedClip
get

Gets the localized audio clip if available.

Returns
The localized AudioClip or null.

◆ LockSettings

bool BBPGlue.API.BBPSoundObject.LockSettings
getset

Gets or sets whether settings for this sound are locked from modification.

Returns
True if settings are locked; otherwise false.

◆ Mixer

AudioMixerGroup? BBPGlue.API.BBPSoundObject.Mixer
getset

Gets or sets the mixer group used for this sound.

Returns
The AudioMixerGroup or null.

◆ MixerOverride

AudioMixerGroup? BBPGlue.API.BBPSoundObject.MixerOverride
getset

Gets or sets an optional mixer group override for the sound.

Returns
The AudioMixerGroup or null.

◆ Raw

object? BBPGlue.API.BBPSoundObject.Raw
get

The raw underlying sound object wrapped by this API class, or null if none.

◆ SoundType

object? BBPGlue.API.BBPSoundObject.SoundType
getset

Gets or sets the sound type enum/value associated with the sound.

Returns
The sound type object or null.

◆ Subtitle

bool BBPGlue.API.BBPSoundObject.Subtitle
getset

Gets or sets whether subtitles should be displayed for this sound.

Returns
True if subtitles are enabled; otherwise false.

◆ SubtitleDuration

float BBPGlue.API.BBPSoundObject.SubtitleDuration
getset

Gets or sets the duration for subtitles associated with this sound.

Returns
The subtitle duration in seconds as a float.

◆ VolumeMultiplier

float BBPGlue.API.BBPSoundObject.VolumeMultiplier
getset

Gets or sets the volume multiplier applied to this sound.

Returns
The volume multiplier as a float.
The documentation for this class was generated from the following file: