How 3D `Class.Sound|Sounds` attenuate (fade out) as the distance between the
listener and the Sound's parent increases.

## What is Attenuation?

Acoustic attenuation refers to how sound diminishes as it travels through a
medium or across increasing distances.

## Inverse vs Linear Distance Attenuation

Inverse distance attenuation (Enum.RollOffMode.Inverse) mirrors how sounds
attenuate in the real world. Under inverse distance attenuation, sounds will
begin to attenuate once the distance between the listener and the Sound's
parent exceeds `Class.Sound.EmitterSize`. The rate of attenuation depends on
the emitter size, as sounds with larger EmitterSize's will attenuate at a
slower rate. Inverse rate of inverse distance attenuation is further
influenced by `Class.SoundService.RolloffScale`.

Note, `Class.Sound.MaxDistance` will not effect attenuation under the inverse
model but will cause the sound to cut off completely once this distance is
reached. This can be particularly abrupt when using low values for max
distance.

Linear distance attenuation works differently. Under linear distance
attenuation the sound will attenuate between EmitterSize and MaxDistance,
falling silent once MaxDistance is reached. EmitterSize still denotes the
point at which the sound will begin attenuating. However, the audible volume
at any point now depends on the point the listener is at between EmitterSize
and MaxDistance. This means, in contrast to the inverse distance attenuation
model, the audible volume of the sound will approach silence at MaxDistance
point. This is less realistic, but may be more desirable in some cases.


Inverse

Volume attenuates from `Class.Sound.RollOffMinDistance` in an inverse
manner.


Linear

Volume attenuates between `Class.Sound.RollOffMinDistance` and
`Class.Sound.RollOffMaxDistance` with a linear relationship.


LinearSquare

Volume attenuates between `Class.Sound.RollOffMinDistance` and
`Class.Sound.RollOffMaxDistance` with a linear squared relationship.


InverseTapered

A hybrid model. Follows the Inverse model when close to
`Class.Sound.RollOffMinDistance` and the Linear Square model when close to
`Class.Sound.RollOffMaxDistance`.


RollOffMode

How 3D `Class.Sound|Sounds` attenuate (fade out) as the distance between the
listener and the Sound's parent increases.


Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

{pageTitle} | {SiteName}

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.

RollOffMode

Items