rules

.cursor/rules/roblox/reference/engine/classes/AudioReverb.yaml

@@ -0,0 +1,376 @@
+# 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: AudioReverb
+type: class
+memory_category: Internal
+summary: |
+  Reverberates audio streams.
+description: |
+  `Class.AudioReverb` reverberates audio streams, modeling the natural echoes of
+  a room or enclosed space. 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: AudioReverb.Bypass
+    summary: |
+      Whether audio streams are passed-through unaffected by this effect.
+    description: |
+      If `true`, audio streams are passed-through unaffected by this effect.
+    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: AudioReverb.DecayRatio
+    summary: |
+      Controls how quickly high frequency sound decays compared to the overall
+      reverb.
+    description: |
+      A ratio of high frequency decay time to total decay time, where high
+      frequencies are determined to be anything above
+      `Class.AudioReverb.ReferenceFrequency|ReferenceFrequency`, in hertz.
+      Ranges from 0.1 to 1.
+    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: AudioReverb.DecayTime
+    summary: |
+      Controls how long it takes for the reverb to dissipate.
+    description: |
+      Time, in seconds, that it will take for the reverb to fully decay. Ranges
+      from 0.1 to 20.
+    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: AudioReverb.Density
+    summary: |
+      Controls how many reflections are generated.
+    description: |
+      A number controlling how many reflections are generated. Ranges from 0
+      to 1.
+    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: AudioReverb.Diffusion
+    summary: |
+      Controls how smooth and reflective the simulated surfaces are.
+    description: |
+      A number controlling how smooth and reflective the reverb's simulated
+      surfaces are. Ranges from 0 to 1.
+    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: AudioReverb.DryLevel
+    summary: |
+      Gain level determining how loud the original, unaltered audio stream will
+      be.
+    description: |
+      Gain level, in decibels, determining how loud the original, unaltered
+      audio stream will be. Ranges from -80 to 20.
+    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: AudioReverb.EarlyDelayTime
+    summary: |
+      Controls the amount of time before reverberation begins .
+    description: |
+      Time, in seconds, before any reverberation begins. Ranges from 0 to 0.3.
+    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: AudioReverb.HighCutFrequency
+    summary: |
+      Frequency above which sound is filtered out of the reverb.
+    description: |
+      Frequency, in hertz, which acts as a cutoff for a low-pass filter. Any
+      audio that has a higher frequency than this is excluded from the reverb.
+      Ranges from 20 to 20,000.
+    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: AudioReverb.LateDelayTime
+    summary: |
+      Time, following early delays, before diffuse reverberations begin.
+    description: |
+      Time in seconds, following early delays, before diffuse reverberations
+      begin. Ranges from 0 to 0.1.
+    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: AudioReverb.LowShelfFrequency
+    summary: |
+      Frequency below which audio can be boosted or reduced in the reverb.
+    description: |
+      Frequency, in hertz, below which audio can be boosted or reduced in the
+      reverb via `Class.AudioReverb.LowShelfGain|LowShelfGain`. Ranges from 20
+      to 20,000.
+    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: AudioReverb.LowShelfGain
+    summary: |
+      Controls the presence of low frequency content in the reverb.
+    description: |
+      Gain level, in decibels, that controls the presence of low frequency
+      content in the reverb. Ranges from -36 to 12.
+    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: AudioReverb.ReferenceFrequency
+    summary: |
+      Frequency that separates low frequency decay speeds from high frequency
+      decay speeds.
+    description: |
+      Frequency, in hertz, that separates low frequency decay speeds from high
+      frequency decay speeds. This is used by
+      `Class.AudioReverb.DecayRatio|DecayRatio` to determine whether low or high
+      frequencies decay faster. Ranges from 20 to 20,000.
+    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: AudioReverb.WetLevel
+    summary: |
+      Gain level determining how loud the reverberated stream will be.
+    description: |
+      Gain level, in decibels, determining how loud the reverberated stream will
+      be. Ranges from -80 to 20.
+    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: AudioReverb:GetConnectedWires
+    summary: |
+      Returns an array of `Class.Wire|Wires` that are connected to the specified
+      pin.
+    description: |
+      Returns an array of `Class.Wire|Wires` that are connected to the specified
+      pin. `Class.AudioReverb` has one "Input" pin and one "Output" pin.
+    code_samples: []
+    parameters:
+      - name: pin
+        type: string
+        default:
+        summary: ''
+    returns:
+      - type: Instances
+        summary: ''
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - Audio
+  - name: AudioReverb:GetInputPins
+    summary: ''
+    description: ''
+    code_samples: []
+    parameters: []
+    returns:
+      - type: Array
+        summary: ''
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - Audio
+  - name: AudioReverb:GetOutputPins
+    summary: ''
+    description: ''
+    code_samples: []
+    parameters: []
+    returns:
+      - type: Array
+        summary: ''
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - Audio
+events:
+  - name: AudioReverb.WiringChanged
+    summary: |
+      Fires when another instance is connected to or disconnected from the
+      `Class.AudioReverb` via a `Class.Wire`.
+    description: |
+      Event that fires after a `Class.Wire` becomes connected or disconnected,
+      and that `Class.Wire` is now or was previously connected to a pin on the
+      `Class.AudioReverb` and to some other wirable instance.
+    code_samples: []
+    parameters:
+      - name: connected
+        type: boolean
+        default:
+        summary: |
+          Whether the instance got connected or disconnected.
+      - name: pin
+        type: string
+        default:
+        summary: |
+          The pin on the `Class.AudioReverb` that the `Class.Wire` targets.
+      - name: wire
+        type: Wire
+        default:
+        summary: |
+          The `Class.Wire` between the `Class.AudioReverb` and the other
+          instance.
+      - name: instance
+        type: Instance
+        default:
+        summary: |
+          The other instance that is or was connected through the `Class.Wire`.
+    tags: []
+    deprecation_message: ''
+    security: None
+    capabilities:
+      - Audio
+callbacks: []