Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ChorusSoundEffect

Makes audio more voluminous by simulating multiple voices playing the same part.

Memory categoryInstances

Member index 3

HistoryMember
553Depth: float
553Mix: float
553Rate: 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

A ChorusSoundEffect simulates the effect of multiple vocals or instruments playing the same part. It does this by taking the original sound and overlaying copies of that sound. These copies are not exact matches to the original but instead vary in pitch slightly. This simulates a real chorus, as different singers or instruments will have slight variations. This effect can be applied to either an individual sound or to a sound group by parenting it to the desired instance.

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

History 13

Members 3

Depth

TypeDefault
float0.150000006

Range: 0 to 1 (default 0.15) Controls how intense the effect is.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

  • 553 Change Default of Depth from to 0.150000006
  • 486 Change ThreadSafety of Depth from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Depth from to ReadOnly
  • 264 Add Depth

Mix

TypeDefault
float0.5

Range: 0 to 1 (default 0.5) Percentage of the original sound that will be applied to the filter. Raising this value will make the effect sound louder and be more apparent.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

  • 553 Change Default of Mix from to 0.5
  • 486 Change ThreadSafety of Mix from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Mix from to ReadOnly
  • 264 Add Mix

Rate

TypeDefault
float0.5

Range: 0 to 20 (default 0.5) How frequently the pitch variation changes. Measured in Hz.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

  • 553 Change Default of Rate from to 0.5
  • 486 Change ThreadSafety of Rate from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Rate from to ReadOnly
  • 264 Add Rate

Settings