Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AudioTremolo

Creates a trembling effect on a sound by varying the volume of the sound up and down.

Member index 11

HistoryMember
689Bypass: bool
689Depth: float
689Duty: float
689Frequency: float
689Shape: float
689Skew: float
689Square: float
689GetConnectedWires(pin: string): Instances
689GetInputPins(): Array
689GetOutputPins(): Array
689WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance)
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

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.

History 13

Members 11

Bypass

TypeDefault
boolfalse

History 1

Depth

TypeDefault
float1

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.

History 1

Duty

TypeDefault
float0.5

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.

History 1

Frequency

TypeDefault
float5

Sets how often the effect will oscillate the volume, measured in Hz, in the range of 0.1 to 20. Default is 5.

History 1

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Instances

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

History 1

GetInputPins

Parameters (0)
No parameters.
Returns (1)
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.

History 1

GetOutputPins

Parameters (0)
No parameters.
Returns (1)
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.

History 1

Shape

TypeDefault
float0

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.

History 1

Skew

TypeDefault
float0

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.

History 1

Square

TypeDefault
float0

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.

History 1

WiringChanged

Parameters (4)
connectedbool
pinstring
wireWire
instanceInstance

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.

History 1

Settings