mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
88 lines
2.5 KiB
YAML
88 lines
2.5 KiB
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: FlangeSoundEffect
|
|
type: class
|
|
memory_category: Instances
|
|
summary: |
|
|
Creates a sweeping or swooshing effect on a sound.
|
|
description: |
|
|
The FlangeSoundEffect creates a sweeping or swooshing effect on the Sound or
|
|
SoundGroup it is applied to. It does this by copying the original audio signal
|
|
and playing on top of the original but slightly offset and modulated.
|
|
|
|
Like all other `Class.SoundEffect`, a FlangeSoundEffect can be applied either
|
|
to a `Class.Sound` or `Class.SoundGroup` by being parented to either.
|
|
code_samples: []
|
|
inherits:
|
|
- SoundEffect
|
|
descendants: []
|
|
tags: []
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: FlangeSoundEffect.Depth
|
|
summary: |
|
|
The intensity of the effect.
|
|
description: |
|
|
Range: 0.01 to 1 (default 0.45) The intensity of the effect. This value
|
|
determines how offset the duplicated signal will be from the original.
|
|
This value is the percentage of the max offset (40ms).
|
|
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:
|
|
- LegacySound
|
|
- name: FlangeSoundEffect.Mix
|
|
summary: |
|
|
Percentage of the original sound that will be applied to the filter.
|
|
description: |
|
|
Range: 0 to 1 (default 0.85) Percentage of the original sound that will be
|
|
applied to the filter. Raising this value will make the effect sound
|
|
louder and be more apparent.
|
|
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:
|
|
- LegacySound
|
|
- name: FlangeSoundEffect.Rate
|
|
summary: |
|
|
The frequency that the effect oscillates at.
|
|
description: |
|
|
Range: 0 to 20 (default 5) The frequency that the effect oscillates at.
|
|
Measured in Hz.
|
|
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:
|
|
- LegacySound
|
|
methods: []
|
|
events: []
|
|
callbacks: []
|