The BaseSoundComponent class in the Sandbox namespace is an abstract class that provides a foundation for sound components in a scene. It inherits from the Component class and is designed to manage audio playback, including properties for sound events, volume, pitch, and various sound effects like occlusion and reflection.
| Member Name | Summary |
|---|---|
| TargetMixer | The mixer we want this sound to play through. |
| SoundEvent | The sound event associated with this component. |
| PlayOnStart | Indicates if the sound should play when the component starts. |
| StopOnNew | Determines if the current sound should stop when a new sound is played. |
| SoundOverride | Enables overriding of sound properties. |
| Volume | Controls the volume of the sound, ranging from 0 to 1. |
| Pitch | Adjusts the pitch of the sound, ranging from 0 to 2. |
| Force2d | Forces the sound to be played in 2D. |
| Repeat | Enables the sound to repeat. |
| MinRepeatTime | Minimum time between sound repeats. |
| MaxRepeatTime | Maximum time between sound repeats. |
| DistanceAttenuationOverride | Enables overriding of distance attenuation settings. |
| DistanceAttenuation | Determines if distance attenuation is applied. |
| Distance | Sets the distance for sound attenuation. |
| Falloff | Defines the falloff curve for distance attenuation. |
| OcclusionOverride | Enables overriding of occlusion settings. |
| Occlusion | Determines if occlusion effects are applied. |
| OcclusionRadius | Sets the radius for occlusion effects. |
| ReflectionOverride | Enables overriding of reflection settings. |
| Reflections | Determines if reflection effects are applied. |
| Member Name | Summary |
|---|---|
| StartSound | Begins playback of the sound. |
| StopSound | Stops playback of the sound. |