DistortionSoundEffect
Distorts an audio signal by applying nonlinear gain.
- Creatable
Instance.new("DistortionSoundEffect")- Inherits
- SoundEffectInstance
- Replication
- Standard
Behavior
DistortionSoundEffect distorts an audio signal by applying nonlinear gain.
Summary
The input gain used for audio distortion.
Whether this effect processes the audio signal.
The blend between the dry and processed audio signal.
The relative priority used to order or process this object.
The tone control applied to distorted audio.
Returns this instance if it is an ExecutionGroup.
Properties
Drive
DistortionSoundEffect.Drive: number = 0.5The input gain used for audio distortion.
Enabled
DistortionSoundEffect.Enabled: boolean = trueWhether this effect processes the audio signal.
Mix
DistortionSoundEffect.Mix: number = 0.5The blend between the dry and processed audio signal.
Priority
DistortionSoundEffect.Priority: number = 0The relative priority used to order or process this object.
Tone
DistortionSoundEffect.Tone: number = 0.5The tone control applied to distorted audio.
Methods
GetExecutionGroup
DistortionSoundEffect:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying