Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ReverbSoundEffect

Reverberates audio, simulating the effect of bouncing off walls in a room.

Memory categoryInstances

Member index 5

HistoryMember
553DecayTime: float
553Density: float
553Diffusion: float
553DryLevel: float
553WetLevel: float
inherited from SoundEffect
553Enabled: bool
553Priority: int
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

The ReverbSoundEffect simulates the effect of sounds bouncing off of several surfaces (such as walls in a room), which causes several overlapping echoes that arrive at the listener at slightly offset times.

Like all other SoundEffects, a ReverbSoundEffect can be applied either to a Sound or SoundGroup by being parented to either.

History 21

Members 5

DecayTime

TypeDefault
float1.5

Range: 0.1 to 20 (default 1.5) Sets how long it takes for the reverberating echoes to fade out completely. Larger decay times simulate larger (empty) spaces

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

Density

TypeDefault
float1

Range: 0 to 1 (default 1) Controls how many reflections are generated.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

Diffusion

TypeDefault
float1

Range: 0 to 1 (default 1) Controls how smooth and reflective the simulated surfaces are. The lower this value, the more discrete the echoes are. At higher levels the echos will blend more.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

DryLevel

TypeDefault
float-6

Range: -80 to 10 (default -6) The output volume of the original sound.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

WetLevel

TypeDefault
float0

Range: -80 to 10 (default 0) The output volume of the echoed effect.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

Settings