Skip to content

Commit bf5cd83

Browse files
rbxphogenrbxphogen
committed
add descriptions for SpectrumEnabled, Bypass, and GetConnectedWires
1 parent 1d1a378 commit bf5cd83

16 files changed

+91
-54
lines changed

‎content/en-us/reference/engine/classes/AudioAnalyzer.yaml‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,13 @@ properties:
5858
can_load: false
5959
can_save: true
6060
- name: AudioAnalyzer.SpectrumEnabled
61-
summary: ''
62-
description: ''
61+
summary: 'Enables usage of `Class.AudioAnalyzer:GetSpectrum|GetSpectrum`'
62+
description: |
63+
Enables usage of `Class.AudioAnalyzer:GetSpectrum|GetSpectrum`.
64+
If false, `Class.AudioAnalyzer:GetSpectrum|GetSpectrum` returns an empty array,
65+
but the CPU overhead of this `Class.AudioAnalyzer` is dramatically reduced.
66+
So, if you are only analyzing the *volume* of an audio stream,
67+
this can be disabled to improve performance.
6368
code_samples: []
6469
type: bool
6570
tags: []
@@ -74,8 +79,10 @@ properties:
7479
can_save: true
7580
methods:
7681
- name: AudioAnalyzer:GetConnectedWires
77-
summary: ''
78-
description: ''
82+
summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin'
83+
description: |
84+
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
85+
`Class.AudioAnalyzer` has one "Input" pin.
7986
code_samples: []
8087
parameters:
8188
- name: pin

‎content/en-us/reference/engine/classes/AudioChorus.yaml‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ tags: []
2121
deprecation_message: ''
2222
properties:
2323
- name: AudioChorus.Bypass
24-
summary: ''
25-
description: ''
24+
summary: 'If True, audio streams are passed-through unaffected by this effect.'
25+
description: 'If True, audio streams are passed-through unaffected by this effect.'
2626
code_samples: []
2727
type: bool
2828
tags: []
@@ -93,8 +93,10 @@ properties:
9393
can_save: true
9494
methods:
9595
- name: AudioChorus:GetConnectedWires
96-
summary: ''
97-
description: ''
96+
summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin'
97+
description: |
98+
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
99+
`Class.AudioChorus` has one "Input" pin, and one "Output" pin.
98100
code_samples: []
99101
parameters:
100102
- name: pin

‎content/en-us/reference/engine/classes/AudioCompressor.yaml‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ properties:
4040
can_load: true
4141
can_save: true
4242
- name: AudioCompressor.Bypass
43-
summary: ''
44-
description: ''
43+
summary: 'If True, audio streams are passed-through unaffected by this effect.'
44+
description: 'If True, audio streams are passed-through unaffected by this effect.'
4545
code_samples: []
4646
type: bool
4747
tags: []
@@ -144,8 +144,10 @@ properties:
144144
can_save: true
145145
methods:
146146
- name: AudioCompressor:GetConnectedWires
147-
summary: ''
148-
description: ''
147+
summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin'
148+
description: |
149+
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
150+
`Class.AudioCompressor` has one "Input" pin, one "Sidechain" pin, and one "Output" pin.
149151
code_samples: []
150152
parameters:
151153
- name: pin

‎content/en-us/reference/engine/classes/AudioDeviceInput.yaml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,8 +168,10 @@ properties:
168168
can_save: true
169169
methods:
170170
- name: AudioDeviceInput:GetConnectedWires
171-
summary: ''
172-
description: ''
171+
summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin'
172+
description: |
173+
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
174+
`Class.AudioDeviceInput` has one "Output" pin.
173175
code_samples: []
174176
parameters:
175177
- name: pin

‎content/en-us/reference/engine/classes/AudioDeviceOutput.yaml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,10 @@ properties:
3838
can_save: true
3939
methods:
4040
- name: AudioDeviceOutput:GetConnectedWires
41-
summary: ''
42-
description: ''
41+
summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin'
42+
description: |
43+
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
44+
`Class.AudioDeviceOutput` has one "Input" pin.
4345
code_samples: []
4446
parameters:
4547
- name: pin

‎content/en-us/reference/engine/classes/AudioDistortion.yaml‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ tags: []
1515
deprecation_message: ''
1616
properties:
1717
- name: AudioDistortion.Bypass
18-
summary: ''
19-
description: ''
18+
summary: 'If True, audio streams are passed-through unaffected by this effect.'
19+
description: 'If True, audio streams are passed-through unaffected by this effect.'
2020
code_samples: []
2121
type: bool
2222
tags: []
@@ -48,8 +48,10 @@ properties:
4848
can_save: true
4949
methods:
5050
- name: AudioDistortion:GetConnectedWires
51-
summary: ''
52-
description: ''
51+
summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin'
52+
description: |
53+
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
54+
`Class.AudioDistortion` has one "Input" pin, and one "Output" pin.
5355
code_samples: []
5456
parameters:
5557
- name: pin

‎content/en-us/reference/engine/classes/AudioEcho.yaml‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ tags: []
1515
deprecation_message: ''
1616
properties:
1717
- name: AudioEcho.Bypass
18-
summary: ''
19-
description: ''
18+
summary: 'If True, audio streams are passed-through unaffected by this effect.'
19+
description: 'If True, audio streams are passed-through unaffected by this effect.'
2020
code_samples: []
2121
type: bool
2222
tags: []
@@ -104,8 +104,10 @@ properties:
104104
can_save: true
105105
methods:
106106
- name: AudioEcho:GetConnectedWires
107-
summary: ''
108-
description: ''
107+
summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin'
108+
description: |
109+
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
110+
`Class.AudioEcho` has one "Input" pin, and one "Output" pin.
109111
code_samples: []
110112
parameters:
111113
- name: pin

‎content/en-us/reference/engine/classes/AudioEmitter.yaml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,10 @@ properties:
6969
can_save: true
7070
methods:
7171
- name: AudioEmitter:GetConnectedWires
72-
summary: ''
73-
description: ''
72+
summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin'
73+
description: |
74+
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
75+
`Class.AudioEmitter` has one "Input" pin.
7476
code_samples: []
7577
parameters:
7678
- name: pin

‎content/en-us/reference/engine/classes/AudioEqualizer.yaml‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ tags: []
1818
deprecation_message: ''
1919
properties:
2020
- name: AudioEqualizer.Bypass
21-
summary: ''
22-
description: ''
21+
summary: 'If True, audio streams are passed-through unaffected by this effect.'
22+
description: 'If True, audio streams are passed-through unaffected by this effect.'
2323
code_samples: []
2424
type: bool
2525
tags: []
@@ -129,8 +129,10 @@ properties:
129129
can_save: true
130130
methods:
131131
- name: AudioEqualizer:GetConnectedWires
132-
summary: ''
133-
description: ''
132+
summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin'
133+
description: |
134+
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
135+
`Class.AudioEqualizer` has one "Input" pin, and one "Output" pin.
134136
code_samples: []
135137
parameters:
136138
- name: pin

‎content/en-us/reference/engine/classes/AudioFader.yaml‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ tags: []
1515
deprecation_message: ''
1616
properties:
1717
- name: AudioFader.Bypass
18-
summary: ''
19-
description: ''
18+
summary: 'If True, audio streams are passed-through unaffected by this effect.'
19+
description: 'If True, audio streams are passed-through unaffected by this effect.'
2020
code_samples: []
2121
type: bool
2222
tags: []
@@ -49,8 +49,10 @@ properties:
4949
can_save: true
5050
methods:
5151
- name: AudioFader:GetConnectedWires
52-
summary: ''
53-
description: ''
52+
summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin'
53+
description: |
54+
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
55+
`Class.AudioFader` has one "Input" pin, and one "Output" pin.
5456
code_samples: []
5557
parameters:
5658
- name: pin

0 commit comments

Comments
 (0)