Roblox UtilitiesDevlHub Roblox Documentation

Class

AudioFader

Inherits
Instance › Object
Memory category
Internal

Adjusts the volume of audio streams.

AudioFader adjusts the volume of audio streams. 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
VolumefloatVolume level which is multiplied onto the input stream.ReadSafe

Bypass: boolean#

ReadSafe

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

Volume: float#

ReadSafe

Volume level which is multiplied onto the input stream. Ranges from 0 to 3.

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. AudioFader 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 AudioFader, 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 AudioFader, 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 AudioFader 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 AudioFader and to some other wirable instance.

NameTypeDefaultDescription
connectedbooleanWhether the instance got connected or disconnected.
pinstringThe pin on the AudioFader that the Wire targets.
wireWireThe Wire between the AudioFader 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