Roblox UtilitiesDevlHub Roblox Documentation

Class

AudioDistortion

Inherits
Instance › Object
Memory category
Internal

Distorts audio streams, making them sound fuzzier, grittier, and louder.

AudioDistortion distorts audio streams, making them sound fuzzier, grittier, and louder. It provides one Input pin and one Output pin which can be connected to/from by Wires.

Properties 2#

BypassbooleanWhether audio streams are passed-through unaffected by this effect.ReadSafe
LevelfloatControls how distorted the input stream will become.ReadSafe

Bypass: boolean#

ReadSafe

If true, audio streams are passed-through unaffected by this effect.

Level: float#

ReadSafe

Controls how distorted the input stream will become. Ranges from 0 to 1.

Methods 3#

GetConnectedWiresReturns an array of Wires that are connected to the specified pin.
GetInputPinsGets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property.
GetOutputPinsGets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property.

GetConnectedWires(pin: string): List<Wire>#

Returns an array of Wires that are connected to the specified pin. AudioDistortion has one "Input" pin and one "Output" pin.

NameTypeDefaultDescription
pinstringAn input or output pin on this instance
Returns
  • List<Wire> — An array of Wires

GetInputPins(): Array#

Gets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property.

For AudioDistortion, this is Input only.

Returns
  • Array — An array of strings representing valid pin names.

GetOutputPins(): Array#

Gets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property.

For AudioDistortion, this is Output only.

Returns
  • Array — An array of strings representing valid pin names.

Events 1#

WiringChangedFires when another instance is connected to or disconnected from the AudioDistortion via a Wire.

WiringChanged(connected: boolean, pin: string, wire: Wire, instance: Instance)#

Event that fires after a Wire becomes connected or disconnected, and that Wire is now or was previously connected to a pin on the AudioDistortion and to some other wirable instance.

NameTypeDefaultDescription
connectedbooleanWhether the instance got connected or disconnected.
pinstringThe pin on the AudioDistortion that the Wire targets.
wireWireThe Wire between the AudioDistortion and the other instance.
instanceInstanceThe other instance that is or was connected through the Wire.

Inherited members#

Inherited from Instance 58
Inherited from Object 6
Properties (2)

ClassName, className

Events (1)

Changed