Class
AudioTremolo
Creates a trembling effect on a sound by varying the volume of the sound up and down.
AudioTremolo creates a trembling effect on a sound by varying the
volume of the sound up and down. It provides one Input pin and one
Output pin which can be connected to/from by Wires.
Properties 7#
Bypassboolean | Whether audio streams are passed-through unaffected by this effect.ReadSafe |
Depthfloat | Controls how much the volume will raise and lower.ReadSafe |
Dutyfloat | Controls how long the effect will be active during one volume oscillation.ReadSafe |
Frequencyfloat | Sets how often the effect will oscillate the volume.ReadSafe |
Shapefloat | Controls the shape of the low frequency oscillations.ReadSafe |
Skewfloat | Time-skews the low frequency oscillations cycle.ReadSafe |
Squarefloat | Flatness of the low frequency oscillations shape.ReadSafe |
Bypass: boolean#
ReadSafe
If true, audio streams are passed-through unaffected by this effect.
Depth: float#
ReadSafe
Controls how much the volume will raise and lower, ranging between 0 and
1 with a default of 1. If set to 0, the volume will not oscillate at
all.
Duty: float#
ReadSafe
Controls how long the effect will be active during one volume oscillation
in the range of 0 (0%) to 1 (100%). Default is 0.5.
Frequency: float#
ReadSafe
Sets how often the effect will oscillate the volume, measured in Hz, in
the range of 0.1 to 20. Default is 5.
Shape: float#
ReadSafe
Morphs the LFO (low frequency oscillation) shape in a range of 0 to 1
where 0 is triangle and 1 is sine. Default is 0.
Skew: float#
ReadSafe
Controls the time-skewing of the LFO (low frequency oscillation) cycle in
the range of -1 to 1. No skewing occurs at 0, with more extremal
forwards and backwards skewing towards +1/-1. Default is 0.
Square: float#
ReadSafe
Determines the squareness of the oscillations in the range of 0 to 1.
The original shape is retained when 0 and the shape flattens more as the
value increases. Default is 0.
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. AudioTremolo 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 AudioTremolo, 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 AudioTremolo, 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
AudioTremolo 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
AudioTremolo 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 AudioTremolo that the Wire targets. | |
wire | Wire | The Wire between the AudioTremolo 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