Should the sound get absorbed by air, so it sounds different at distance

Measure of audio loudness.

How many units the sound can be heard from.

Should the sound fade out over distance

The fadein curve for when the sound starts.

The fadeout curve for when the sound stops.

The falloff curve for the sound.

Sound is done

Update our position every frame relative to our parent

Whether the sound is currently playing or not.

True if the sound has been stopped

Access lipsync processing.

Place the listener at 0,0,0 facing 1,0,0.

If we're following a parent, our position will be this relative to them.

If true, then this sound won't be played unless voice_loopback is 1. The assumption is that it's the local user's voice. Amplitude and visme data will still be available!

A debug name to help identify the sound

Legacy alias for Sandbox.SoundHandle.OcclusionEnabled.

Allow this sound to be occluded by geometry etc

Legacy occlusion radius setting. No longer used by the simulation.

If set with a parent and is true, we will update our position to match the parent's world position. You can use to set an offset from the parent's position. Setting a parent also allows you to use GameObject.StopAllSounds on the parent to stop all sounds that are following it. This is set automatically when calling on a GameObject, but you can set it manually if you want to change the parent of an existing sound handle.

Whether the sound is currently paused or not.

Pitch of the sound.

Position of the sound.

Legacy alias for Sandbox.SoundHandle.ReverbEnabled.

How much this sound contributes to room reverb. 1 = full reverb, 0 = completely dry.

Enable reverb simulation for this sound (reflections/late reverb).

The direction the sound is facing

How many samples per second?

The sound file this handle is playing, when we know it - sounds played from a Sandbox.SoundHandle.SoundFile or a Sandbox.SoundEvent do, procedural streams don't.

How 3d the sound should be. 0 means no 3d, 1 means fully

The subtitle track of the sound being played, or null if it doesn't have one. Sample Sandbox.SubtitleTrack.WordIndexAt(System.Single) at Sandbox.SoundHandle.Time while the sound plays to show the words as they're spoken, karaoke style - or let Sandbox.SubtitlesGameObjectSystem do it for you.

Which mixer do we want to write to

The current time of the playing sound in seconds. Note: for some formats seeking may be expensive, and some may not support it at all.

This sound's transform

Legacy transmission toggle. Transmission is now derived from occlusion and material response.

Volume of the sound.

Clear our parent - stop following

Tell the SoundHandle to follow this GameObject's position

Called to push changes to a sound immediately, rather than waiting for the next tick. You should call this if you make changes to a sound.