Reference API Roblox

Engine API

Website

Related

Reference API Roblox

FlangeSoundEffect

Creates a sweeping or swooshing effect on a sound.

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
486GetChildren(): Objects
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
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
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
647isA(className: string): bool
647Changed(property: string)

Description

The FlangeSoundEffect creates a sweeping or swooshing effect on the Sound or SoundGroup it is applied to. It does this by copying the original audio signal and playing on top of the original but slightly offset and modulated.

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

History 13

Members 3

Depth

TypeDefault
float0.449999988

Range: 0.01 to 1 (default 0.45) The intensity of the effect. This value determines how offset the duplicated signal will be from the original. This value is the percentage of the max offset (40ms).

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

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

Mix

TypeDefault
float0.850000024

Range: 0 to 1 (default 0.85) 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.850000024
  • 486 Change ThreadSafety of Mix from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Mix from to ReadOnly
  • 264 Add Mix

Rate

TypeDefault
float5

Range: 0 to 20 (default 5) The frequency that the effect oscillates at. Measured in Hz.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

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

Settings