Class
AudioFlanger
Imparts a whooshing or sweeping sound on audio streams.
AudioFlanger imparts a whooshing or sweeping sound on audio streams by
overlaying a delayed copy of the input stream and modulating the pitch of the
copy. It provides one Input pin and one Output pin which can be
connected to/from by Wires.
Properties 4#
Bypassboolean | Whether audio streams are passed-through unaffected by this effect.ReadSafe |
Depthfloat | Controls how strong the pitch modulation of the flanger is.ReadSafe |
Mixfloat | Controls the balance of plain input stream to modified output stream.ReadSafe |
Ratefloat | Controls the rate of pitch modulations.ReadSafe |
Bypass: boolean#
ReadSafe
If true, audio streams are passed-through unaffected by this effect.
Depth: float#
ReadSafe
Controls how strong the pitch modulation of the flanger is. Ranges from 0.01 to 1 which determines the maximum delay time of the modulated signal. A value of 1 corresponds to 10 milliseconds of maximum delay; beyond this, the modulated signal would begin to sound more like an echo than a flange.
Mix: float#
ReadSafe
Controls the balance of plain input stream to modified output stream. Ranges from 0 to 1.
Rate: float#
ReadSafe
Frequency controlling the rate of pitch modulations, in hertz. Ranges from 0 to 20.
Methods 3#
| GetConnectedWires | Returns an array of Wires that are connected to the specified
pin. |
| GetInputPins | Gets the list of pins that Wire can use in Wire.TargetName
to connect to this instance via its Wire.TargetInstance property. |
| GetOutputPins | Gets 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. AudioFlanger has one "Input" pin and one "Output" pin.
| Name | Type | Default | Description |
|---|---|---|---|
pin | string | An input or output pin on this instance |
Returns
List<Wire>— An array ofWires
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 AudioFlanger, 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 AudioFlanger, this is Output only.
Returns
Array— An array of strings representing valid pin names.
Events 1#
| WiringChanged | Fires when another instance is connected to or disconnected from the
AudioFlanger 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
AudioFlanger and to some other wirable instance.
| Name | Type | Default | Description |
|---|---|---|---|
connected | boolean | Whether the instance got connected or disconnected. | |
pin | string | The pin on the AudioFlanger that the Wire targets. | |
wire | Wire | The Wire between the AudioFlanger and the other
instance. | |
instance | Instance | The other instance that is or was connected through the Wire. |
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild