rojo/.cursor/rules/roblox/reference/engine/classes/AudioTremolo.yaml

# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72

name: AudioTremolo
type: class
memory_category: Internal
summary: |
  Creates a trembling effect on a sound by varying the volume of the sound up
  and down.
description: |
  `Class.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 `Class.Wire|Wires`.
code_samples: []
inherits:
  - Instance
descendants: []
tags: []
deprecation_message: ''
properties:
  - name: AudioTremolo.Bypass
    summary: ''
    description: ''
    code_samples: []
    type: boolean
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: State
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Audio
  - name: AudioTremolo.Depth
    summary: |
      Controls how much the volume will raise and lower.
    description: |
      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.
    code_samples: []
    type: float
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: State
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Audio
  - name: AudioTremolo.Duty
    summary: |
      Controls how long the effect will be active during one volume oscillation.
    description: |
      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`.
    code_samples: []
    type: float
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: State
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Audio
  - name: AudioTremolo.Frequency
    summary: |
      Sets how often the effect will oscillate the volume.
    description: |
      Sets how often the effect will oscillate the volume, measured in Hz, in
      the range of `0.1` to `20`. Default is `5`.
    code_samples: []
    type: float
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: State
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Audio
  - name: AudioTremolo.Shape
    summary: |
      Controls the shape of the low frequency oscillations.
    description: |
      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`.
    code_samples: []
    type: float
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: State
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Audio
  - name: AudioTremolo.Skew
    summary: |
      Time-skews the low frequency oscillations cycle.
    description: |
      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`.
    code_samples: []
    type: float
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: State
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Audio
  - name: AudioTremolo.Square
    summary: |
      Flatness of the low frequency oscillations shape.
    description: |
      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`.
    code_samples: []
    type: float
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: State
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Audio
methods:
  - name: AudioTremolo:GetConnectedWires
    summary: ''
    description: ''
    code_samples: []
    parameters:
      - name: pin
        type: string
        default:
        summary: ''
    returns:
      - type: Instances
        summary: ''
    tags: []
    deprecation_message: ''
    security: None
    thread_safety: Unsafe
    capabilities:
      - Audio
  - name: AudioTremolo:GetInputPins
    summary: ''
    description: ''
    code_samples: []
    parameters: []
    returns:
      - type: Array
        summary: ''
    tags: []
    deprecation_message: ''
    security: None
    thread_safety: Unsafe
    capabilities:
      - Audio
  - name: AudioTremolo:GetOutputPins
    summary: ''
    description: ''
    code_samples: []
    parameters: []
    returns:
      - type: Array
        summary: ''
    tags: []
    deprecation_message: ''
    security: None
    thread_safety: Unsafe
    capabilities:
      - Audio
events:
  - name: AudioTremolo.WiringChanged
    summary: ''
    description: ''
    code_samples: []
    parameters:
      - name: connected
        type: boolean
        default:
        summary: ''
      - name: pin
        type: string
        default:
        summary: ''
      - name: wire
        type: Wire
        default:
        summary: ''
      - name: instance
        type: Instance
        default:
        summary: ''
    tags: []
    deprecation_message: ''
    security: None
    capabilities:
      - Audio
callbacks: []