Skip to content

add descriptions for SpectrumEnabled, Bypass, and GetConnectedWires #848

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Sep 30, 2024
Merged

add descriptions for SpectrumEnabled, Bypass, and GetConnectedWires #848

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
bf5cd83
add descriptions for SpectrumEnabled, Bypass, and GetConnectedWires
rbxphogen Sep 30, 2024
ebc6be3
Update content/en-us/reference/engine/classes/AudioAnalyzer.yaml
dandrettarbx Sep 30, 2024
a275f40
Update content/en-us/reference/engine/classes/AudioAnalyzer.yaml
dandrettarbx Sep 30, 2024
7c478ec
Update content/en-us/reference/engine/classes/AudioAnalyzer.yaml
dandrettarbx Sep 30, 2024
265055c
Update content/en-us/reference/engine/classes/AudioAnalyzer.yaml
dandrettarbx Sep 30, 2024
494a291
Update content/en-us/reference/engine/classes/AudioAnalyzer.yaml
dandrettarbx Sep 30, 2024
83ab454
Update content/en-us/reference/engine/classes/AudioPitchShifter.yaml
dandrettarbx Sep 30, 2024
c3e5697
Update content/en-us/reference/engine/classes/AudioPlayer.yaml
dandrettarbx Sep 30, 2024
f13c3d6
Update content/en-us/reference/engine/classes/AudioReverb.yaml
dandrettarbx Sep 30, 2024
f4ad893
Update content/en-us/reference/engine/classes/AudioReverb.yaml
dandrettarbx Sep 30, 2024
f36dc8f
Update content/en-us/reference/engine/classes/AudioReverb.yaml
dandrettarbx Sep 30, 2024
6bfbae9
Update content/en-us/reference/engine/classes/AudioChorus.yaml
dandrettarbx Sep 30, 2024
12c7ec2
Update content/en-us/reference/engine/classes/AudioChorus.yaml
dandrettarbx Sep 30, 2024
0d1dd22
Update content/en-us/reference/engine/classes/AudioChorus.yaml
dandrettarbx Sep 30, 2024
5214896
Update content/en-us/reference/engine/classes/AudioCompressor.yaml
dandrettarbx Sep 30, 2024
44c4158
Update content/en-us/reference/engine/classes/AudioCompressor.yaml
dandrettarbx Sep 30, 2024
3a94d3e
Apply suggestions from code review
dandrettarbx Sep 30, 2024
357854b
Merge branch 'main' into update/audio-bypass-and-connected-wires
dandrettarbx Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions content/en-us/reference/engine/classes/AudioAnalyzer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,13 @@ properties:
can_load: false
can_save: true
- name: AudioAnalyzer.SpectrumEnabled
summary: ''
description: ''
summary: 'Enables usage of `Class.AudioAnalyzer:GetSpectrum|GetSpectrum`'
description: |
Enables usage of `Class.AudioAnalyzer:GetSpectrum|GetSpectrum`.
If false, `Class.AudioAnalyzer:GetSpectrum|GetSpectrum` returns an empty array,
but the CPU overhead of this `Class.AudioAnalyzer` is dramatically reduced.
So, if you are only analyzing the *volume* of an audio stream,
this can be disabled to improve performance.
code_samples: []
type: bool
tags: []
Expand All @@ -74,8 +79,10 @@ properties:
can_save: true
methods:
- name: AudioAnalyzer:GetConnectedWires
summary: ''
description: ''
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.AudioAnalyzer` has one "Input" pin.
code_samples: []
parameters:
- name: pin
Expand Down
10 changes: 6 additions & 4 deletions content/en-us/reference/engine/classes/AudioChorus.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ tags: []
deprecation_message: ''
properties:
- name: AudioChorus.Bypass
summary: ''
description: ''
summary: 'If True, audio streams are passed-through unaffected by this effect.'
description: 'If True, audio streams are passed-through unaffected by this effect.'
code_samples: []
type: bool
tags: []
Expand Down Expand Up @@ -93,8 +93,10 @@ properties:
can_save: true
methods:
- name: AudioChorus:GetConnectedWires
summary: ''
description: ''
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.AudioChorus` has one "Input" pin, and one "Output" pin.
code_samples: []
parameters:
- name: pin
Expand Down
10 changes: 6 additions & 4 deletions content/en-us/reference/engine/classes/AudioCompressor.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ properties:
can_load: true
can_save: true
- name: AudioCompressor.Bypass
summary: ''
description: ''
summary: 'If True, audio streams are passed-through unaffected by this effect.'
description: 'If True, audio streams are passed-through unaffected by this effect.'
code_samples: []
type: bool
tags: []
Expand Down Expand Up @@ -144,8 +144,10 @@ properties:
can_save: true
methods:
- name: AudioCompressor:GetConnectedWires
summary: ''
description: ''
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.AudioCompressor` has one "Input" pin, one "Sidechain" pin, and one "Output" pin.
code_samples: []
parameters:
- name: pin
Expand Down
6 changes: 4 additions & 2 deletions content/en-us/reference/engine/classes/AudioDeviceInput.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,10 @@ properties:
can_save: true
methods:
- name: AudioDeviceInput:GetConnectedWires
summary: ''
description: ''
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.AudioDeviceInput` has one "Output" pin.
code_samples: []
parameters:
- name: pin
Expand Down
6 changes: 4 additions & 2 deletions content/en-us/reference/engine/classes/AudioDeviceOutput.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,10 @@ properties:
can_save: true
methods:
- name: AudioDeviceOutput:GetConnectedWires
summary: ''
description: ''
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.AudioDeviceOutput` has one "Input" pin.
code_samples: []
parameters:
- name: pin
Expand Down
10 changes: 6 additions & 4 deletions content/en-us/reference/engine/classes/AudioDistortion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ tags: []
deprecation_message: ''
properties:
- name: AudioDistortion.Bypass
summary: ''
description: ''
summary: 'If True, audio streams are passed-through unaffected by this effect.'
description: 'If True, audio streams are passed-through unaffected by this effect.'
code_samples: []
type: bool
tags: []
Expand Down Expand Up @@ -48,8 +48,10 @@ properties:
can_save: true
methods:
- name: AudioDistortion:GetConnectedWires
summary: ''
description: ''
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.AudioDistortion` has one "Input" pin, and one "Output" pin.
code_samples: []
parameters:
- name: pin
Expand Down
10 changes: 6 additions & 4 deletions content/en-us/reference/engine/classes/AudioEcho.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ tags: []
deprecation_message: ''
properties:
- name: AudioEcho.Bypass
summary: ''
description: ''
summary: 'If True, audio streams are passed-through unaffected by this effect.'
description: 'If True, audio streams are passed-through unaffected by this effect.'
code_samples: []
type: bool
tags: []
Expand Down Expand Up @@ -104,8 +104,10 @@ properties:
can_save: true
methods:
- name: AudioEcho:GetConnectedWires
summary: ''
description: ''
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.AudioEcho` has one "Input" pin, and one "Output" pin.
code_samples: []
parameters:
- name: pin
Expand Down
6 changes: 4 additions & 2 deletions content/en-us/reference/engine/classes/AudioEmitter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,10 @@ properties:
can_save: true
methods:
- name: AudioEmitter:GetConnectedWires
summary: ''
description: ''
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.AudioEmitter` has one "Input" pin.
code_samples: []
parameters:
- name: pin
Expand Down
10 changes: 6 additions & 4 deletions content/en-us/reference/engine/classes/AudioEqualizer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ tags: []
deprecation_message: ''
properties:
- name: AudioEqualizer.Bypass
summary: ''
description: ''
summary: 'If True, audio streams are passed-through unaffected by this effect.'
description: 'If True, audio streams are passed-through unaffected by this effect.'
code_samples: []
type: bool
tags: []
Expand Down Expand Up @@ -129,8 +129,10 @@ properties:
can_save: true
methods:
- name: AudioEqualizer:GetConnectedWires
summary: ''
description: ''
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.AudioEqualizer` has one "Input" pin, and one "Output" pin.
code_samples: []
parameters:
- name: pin
Expand Down
10 changes: 6 additions & 4 deletions content/en-us/reference/engine/classes/AudioFader.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ tags: []
deprecation_message: ''
properties:
- name: AudioFader.Bypass
summary: ''
description: ''
summary: 'If True, audio streams are passed-through unaffected by this effect.'
description: 'If True, audio streams are passed-through unaffected by this effect.'
code_samples: []
type: bool
tags: []
Expand Down Expand Up @@ -49,8 +49,10 @@ properties:
can_save: true
methods:
- name: AudioFader:GetConnectedWires
summary: ''
description: ''
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.AudioFader` has one "Input" pin, and one "Output" pin.
code_samples: []
parameters:
- name: pin
Expand Down
10 changes: 6 additions & 4 deletions content/en-us/reference/engine/classes/AudioFilter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ tags: []
deprecation_message: ''
properties:
- name: AudioFilter.Bypass
summary: ''
description: ''
summary: 'If True, audio streams are passed-through unaffected by this effect.'
description: 'If True, audio streams are passed-through unaffected by this effect.'
code_samples: []
type: bool
tags: []
Expand Down Expand Up @@ -136,8 +136,10 @@ properties:
can_save: true
methods:
- name: AudioFilter:GetConnectedWires
summary: ''
description: ''
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.AudioFilter` has one "Input" pin, and one "Output" pin.
code_samples: []
parameters:
- name: pin
Expand Down
10 changes: 6 additions & 4 deletions content/en-us/reference/engine/classes/AudioFlanger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ tags: []
deprecation_message: ''
properties:
- name: AudioFlanger.Bypass
summary: ''
description: ''
summary: 'If True, audio streams are passed-through unaffected by this effect.'
description: 'If True, audio streams are passed-through unaffected by this effect.'
code_samples: []
type: bool
tags: []
Expand Down Expand Up @@ -88,8 +88,10 @@ properties:
can_save: true
methods:
- name: AudioFlanger:GetConnectedWires
summary: ''
description: ''
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.AudioFlanger` has one "Input" pin, and one "Output" pin.
code_samples: []
parameters:
- name: pin
Expand Down
6 changes: 4 additions & 2 deletions content/en-us/reference/engine/classes/AudioListener.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,10 @@ properties:
can_save: true
methods:
- name: AudioListener:GetConnectedWires
summary: ''
description: ''
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.AudioListener` has one "Output" pin.
code_samples: []
parameters:
- name: pin
Expand Down
10 changes: 6 additions & 4 deletions content/en-us/reference/engine/classes/AudioPitchShifter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ tags: []
deprecation_message: ''
properties:
- name: AudioPitchShifter.Bypass
summary: ''
description: ''
summary: 'If True, audio streams are passed-through unaffected by this effect.'
description: 'If True, audio streams are passed-through unaffected by this effect.'
code_samples: []
type: bool
tags: []
Expand Down Expand Up @@ -51,8 +51,10 @@ properties:
can_save: true
methods:
- name: AudioPitchShifter:GetConnectedWires
summary: ''
description: ''
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.AudioPitchShifter` has one "Input" pin, and one "Output" pin.
code_samples: []
parameters:
- name: pin
Expand Down
6 changes: 4 additions & 2 deletions content/en-us/reference/engine/classes/AudioPlayer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,8 +275,10 @@ properties:
can_save: true
methods:
- name: AudioPlayer:GetConnectedWires
summary: ''
description: ''
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.AudioPlayer` has one "Output" pin.
code_samples: []
parameters:
- name: pin
Expand Down
10 changes: 6 additions & 4 deletions content/en-us/reference/engine/classes/AudioReverb.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ tags: []
deprecation_message: ''
properties:
- name: AudioReverb.Bypass
summary: ''
description: ''
summary: 'If True, audio streams are passed-through unaffected by this effect.'
description: 'If True, audio streams are passed-through unaffected by this effect.'
code_samples: []
type: bool
tags: []
Expand Down Expand Up @@ -255,8 +255,10 @@ properties:
can_save: true
methods:
- name: AudioReverb:GetConnectedWires
summary: ''
description: ''
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
Expand Down
Loading