From bf5cd83b2b8f7945d15e3837ff5bd98fa32ff99f Mon Sep 17 00:00:00 2001 From: Palmer Hogen Date: Mon, 30 Sep 2024 10:12:13 -0700 Subject: [PATCH 01/17] add descriptions for SpectrumEnabled, Bypass, and GetConnectedWires --- .../reference/engine/classes/AudioAnalyzer.yaml | 15 +++++++++++---- .../reference/engine/classes/AudioChorus.yaml | 10 ++++++---- .../reference/engine/classes/AudioCompressor.yaml | 10 ++++++---- .../engine/classes/AudioDeviceInput.yaml | 6 ++++-- .../engine/classes/AudioDeviceOutput.yaml | 6 ++++-- .../reference/engine/classes/AudioDistortion.yaml | 10 ++++++---- .../en-us/reference/engine/classes/AudioEcho.yaml | 10 ++++++---- .../reference/engine/classes/AudioEmitter.yaml | 6 ++++-- .../reference/engine/classes/AudioEqualizer.yaml | 10 ++++++---- .../reference/engine/classes/AudioFader.yaml | 10 ++++++---- .../reference/engine/classes/AudioFilter.yaml | 10 ++++++---- .../reference/engine/classes/AudioFlanger.yaml | 10 ++++++---- .../reference/engine/classes/AudioListener.yaml | 6 ++++-- .../engine/classes/AudioPitchShifter.yaml | 10 ++++++---- .../reference/engine/classes/AudioPlayer.yaml | 6 ++++-- .../reference/engine/classes/AudioReverb.yaml | 10 ++++++---- 16 files changed, 91 insertions(+), 54 deletions(-) diff --git a/content/en-us/reference/engine/classes/AudioAnalyzer.yaml b/content/en-us/reference/engine/classes/AudioAnalyzer.yaml index 71c966883..79a21d112 100644 --- a/content/en-us/reference/engine/classes/AudioAnalyzer.yaml +++ b/content/en-us/reference/engine/classes/AudioAnalyzer.yaml @@ -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: [] @@ -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 diff --git a/content/en-us/reference/engine/classes/AudioChorus.yaml b/content/en-us/reference/engine/classes/AudioChorus.yaml index 07fd6d6a2..885bd0c3c 100644 --- a/content/en-us/reference/engine/classes/AudioChorus.yaml +++ b/content/en-us/reference/engine/classes/AudioChorus.yaml @@ -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: [] @@ -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 diff --git a/content/en-us/reference/engine/classes/AudioCompressor.yaml b/content/en-us/reference/engine/classes/AudioCompressor.yaml index f81250549..da9c2a50f 100644 --- a/content/en-us/reference/engine/classes/AudioCompressor.yaml +++ b/content/en-us/reference/engine/classes/AudioCompressor.yaml @@ -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: [] @@ -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 diff --git a/content/en-us/reference/engine/classes/AudioDeviceInput.yaml b/content/en-us/reference/engine/classes/AudioDeviceInput.yaml index 91d00c440..25ab8690e 100644 --- a/content/en-us/reference/engine/classes/AudioDeviceInput.yaml +++ b/content/en-us/reference/engine/classes/AudioDeviceInput.yaml @@ -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 diff --git a/content/en-us/reference/engine/classes/AudioDeviceOutput.yaml b/content/en-us/reference/engine/classes/AudioDeviceOutput.yaml index bc46bdc5d..78d89d0cf 100644 --- a/content/en-us/reference/engine/classes/AudioDeviceOutput.yaml +++ b/content/en-us/reference/engine/classes/AudioDeviceOutput.yaml @@ -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 diff --git a/content/en-us/reference/engine/classes/AudioDistortion.yaml b/content/en-us/reference/engine/classes/AudioDistortion.yaml index c7ed67cc7..717f0ee8f 100644 --- a/content/en-us/reference/engine/classes/AudioDistortion.yaml +++ b/content/en-us/reference/engine/classes/AudioDistortion.yaml @@ -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: [] @@ -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 diff --git a/content/en-us/reference/engine/classes/AudioEcho.yaml b/content/en-us/reference/engine/classes/AudioEcho.yaml index 1b883e630..82f09c2ce 100644 --- a/content/en-us/reference/engine/classes/AudioEcho.yaml +++ b/content/en-us/reference/engine/classes/AudioEcho.yaml @@ -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: [] @@ -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 diff --git a/content/en-us/reference/engine/classes/AudioEmitter.yaml b/content/en-us/reference/engine/classes/AudioEmitter.yaml index e7a7c49a5..286b1d87e 100644 --- a/content/en-us/reference/engine/classes/AudioEmitter.yaml +++ b/content/en-us/reference/engine/classes/AudioEmitter.yaml @@ -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 diff --git a/content/en-us/reference/engine/classes/AudioEqualizer.yaml b/content/en-us/reference/engine/classes/AudioEqualizer.yaml index 6812ce2f6..0e1cfb45d 100644 --- a/content/en-us/reference/engine/classes/AudioEqualizer.yaml +++ b/content/en-us/reference/engine/classes/AudioEqualizer.yaml @@ -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: [] @@ -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 diff --git a/content/en-us/reference/engine/classes/AudioFader.yaml b/content/en-us/reference/engine/classes/AudioFader.yaml index 8787ef289..392abe487 100644 --- a/content/en-us/reference/engine/classes/AudioFader.yaml +++ b/content/en-us/reference/engine/classes/AudioFader.yaml @@ -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: [] @@ -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 diff --git a/content/en-us/reference/engine/classes/AudioFilter.yaml b/content/en-us/reference/engine/classes/AudioFilter.yaml index c80cbe9d2..c8a44a886 100644 --- a/content/en-us/reference/engine/classes/AudioFilter.yaml +++ b/content/en-us/reference/engine/classes/AudioFilter.yaml @@ -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: [] @@ -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 diff --git a/content/en-us/reference/engine/classes/AudioFlanger.yaml b/content/en-us/reference/engine/classes/AudioFlanger.yaml index 5fb4104bf..c3cd343a4 100644 --- a/content/en-us/reference/engine/classes/AudioFlanger.yaml +++ b/content/en-us/reference/engine/classes/AudioFlanger.yaml @@ -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: [] @@ -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 diff --git a/content/en-us/reference/engine/classes/AudioListener.yaml b/content/en-us/reference/engine/classes/AudioListener.yaml index 765b6fff7..e15a689b6 100644 --- a/content/en-us/reference/engine/classes/AudioListener.yaml +++ b/content/en-us/reference/engine/classes/AudioListener.yaml @@ -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 diff --git a/content/en-us/reference/engine/classes/AudioPitchShifter.yaml b/content/en-us/reference/engine/classes/AudioPitchShifter.yaml index ec912d0c7..fef30b7c4 100644 --- a/content/en-us/reference/engine/classes/AudioPitchShifter.yaml +++ b/content/en-us/reference/engine/classes/AudioPitchShifter.yaml @@ -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: [] @@ -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 diff --git a/content/en-us/reference/engine/classes/AudioPlayer.yaml b/content/en-us/reference/engine/classes/AudioPlayer.yaml index 29eca94f6..53d22fb33 100644 --- a/content/en-us/reference/engine/classes/AudioPlayer.yaml +++ b/content/en-us/reference/engine/classes/AudioPlayer.yaml @@ -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 diff --git a/content/en-us/reference/engine/classes/AudioReverb.yaml b/content/en-us/reference/engine/classes/AudioReverb.yaml index 3633d89e5..813d946e6 100644 --- a/content/en-us/reference/engine/classes/AudioReverb.yaml +++ b/content/en-us/reference/engine/classes/AudioReverb.yaml @@ -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: [] @@ -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 From ebc6be31868f6a7d8dc34f50d5cc99dcea491c42 Mon Sep 17 00:00:00 2001 From: dandrettarbx <84743954+dandrettarbx@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:41:13 -0700 Subject: [PATCH 02/17] Update content/en-us/reference/engine/classes/AudioAnalyzer.yaml --- content/en-us/reference/engine/classes/AudioAnalyzer.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioAnalyzer.yaml b/content/en-us/reference/engine/classes/AudioAnalyzer.yaml index 79a21d112..76545b459 100644 --- a/content/en-us/reference/engine/classes/AudioAnalyzer.yaml +++ b/content/en-us/reference/engine/classes/AudioAnalyzer.yaml @@ -63,7 +63,7 @@ properties: 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 means that if you are only analyzing the **volume** of an audio stream, this can be disabled to improve performance. code_samples: [] type: bool From a275f40140a008bc2e0973e746eee06b964d4f09 Mon Sep 17 00:00:00 2001 From: dandrettarbx <84743954+dandrettarbx@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:41:20 -0700 Subject: [PATCH 03/17] Update content/en-us/reference/engine/classes/AudioAnalyzer.yaml --- content/en-us/reference/engine/classes/AudioAnalyzer.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioAnalyzer.yaml b/content/en-us/reference/engine/classes/AudioAnalyzer.yaml index 76545b459..d1064d258 100644 --- a/content/en-us/reference/engine/classes/AudioAnalyzer.yaml +++ b/content/en-us/reference/engine/classes/AudioAnalyzer.yaml @@ -58,7 +58,7 @@ properties: can_load: false can_save: true - name: AudioAnalyzer.SpectrumEnabled - summary: 'Enables usage of `Class.AudioAnalyzer:GetSpectrum|GetSpectrum`' + 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, From 7c478ecd60ed951364043f527e179fd4903cbe0d Mon Sep 17 00:00:00 2001 From: dandrettarbx <84743954+dandrettarbx@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:41:25 -0700 Subject: [PATCH 04/17] Update content/en-us/reference/engine/classes/AudioAnalyzer.yaml --- content/en-us/reference/engine/classes/AudioAnalyzer.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioAnalyzer.yaml b/content/en-us/reference/engine/classes/AudioAnalyzer.yaml index d1064d258..a07694140 100644 --- a/content/en-us/reference/engine/classes/AudioAnalyzer.yaml +++ b/content/en-us/reference/engine/classes/AudioAnalyzer.yaml @@ -62,7 +62,7 @@ properties: 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. + but the CPU overhead of the `Class.AudioAnalyzer` is dramatically reduced. This means that if you are only analyzing the **volume** of an audio stream, this can be disabled to improve performance. code_samples: [] From 265055cb2f45dd5fcbe08f9bfe47b57a349561c2 Mon Sep 17 00:00:00 2001 From: dandrettarbx <84743954+dandrettarbx@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:41:30 -0700 Subject: [PATCH 05/17] Update content/en-us/reference/engine/classes/AudioAnalyzer.yaml --- content/en-us/reference/engine/classes/AudioAnalyzer.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioAnalyzer.yaml b/content/en-us/reference/engine/classes/AudioAnalyzer.yaml index a07694140..aa5e7c663 100644 --- a/content/en-us/reference/engine/classes/AudioAnalyzer.yaml +++ b/content/en-us/reference/engine/classes/AudioAnalyzer.yaml @@ -64,7 +64,7 @@ properties: If false, `Class.AudioAnalyzer:GetSpectrum|GetSpectrum` returns an empty array, but the CPU overhead of the `Class.AudioAnalyzer` is dramatically reduced. This means that if you are only analyzing the **volume** of an audio stream, - this can be disabled to improve performance. + you can disable this property to improve performance. code_samples: [] type: bool tags: [] From 494a2918d4ed5bbe842662d6c7acf127d3392874 Mon Sep 17 00:00:00 2001 From: dandrettarbx <84743954+dandrettarbx@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:41:35 -0700 Subject: [PATCH 06/17] Update content/en-us/reference/engine/classes/AudioAnalyzer.yaml --- content/en-us/reference/engine/classes/AudioAnalyzer.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioAnalyzer.yaml b/content/en-us/reference/engine/classes/AudioAnalyzer.yaml index aa5e7c663..af79cbc17 100644 --- a/content/en-us/reference/engine/classes/AudioAnalyzer.yaml +++ b/content/en-us/reference/engine/classes/AudioAnalyzer.yaml @@ -79,7 +79,7 @@ properties: can_save: true methods: - name: AudioAnalyzer:GetConnectedWires - summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin' + 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. From 83ab4540f6a5234fc43395c92bc658191a997fbd Mon Sep 17 00:00:00 2001 From: dandrettarbx <84743954+dandrettarbx@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:41:40 -0700 Subject: [PATCH 07/17] Update content/en-us/reference/engine/classes/AudioPitchShifter.yaml --- content/en-us/reference/engine/classes/AudioPitchShifter.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioPitchShifter.yaml b/content/en-us/reference/engine/classes/AudioPitchShifter.yaml index fef30b7c4..7acc2bc54 100644 --- a/content/en-us/reference/engine/classes/AudioPitchShifter.yaml +++ b/content/en-us/reference/engine/classes/AudioPitchShifter.yaml @@ -51,7 +51,7 @@ properties: can_save: true methods: - name: AudioPitchShifter:GetConnectedWires - summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin' + 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. From c3e56974a6cbabcb01fc8b63e7a71975ddaba079 Mon Sep 17 00:00:00 2001 From: dandrettarbx <84743954+dandrettarbx@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:41:46 -0700 Subject: [PATCH 08/17] Update content/en-us/reference/engine/classes/AudioPlayer.yaml --- content/en-us/reference/engine/classes/AudioPlayer.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioPlayer.yaml b/content/en-us/reference/engine/classes/AudioPlayer.yaml index 53d22fb33..84de01dd3 100644 --- a/content/en-us/reference/engine/classes/AudioPlayer.yaml +++ b/content/en-us/reference/engine/classes/AudioPlayer.yaml @@ -275,7 +275,7 @@ properties: can_save: true methods: - name: AudioPlayer:GetConnectedWires - summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin' + 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. From f13c3d651b0e7bf653063be2a49d00a7783584af Mon Sep 17 00:00:00 2001 From: dandrettarbx <84743954+dandrettarbx@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:41:51 -0700 Subject: [PATCH 09/17] Update content/en-us/reference/engine/classes/AudioReverb.yaml --- content/en-us/reference/engine/classes/AudioReverb.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioReverb.yaml b/content/en-us/reference/engine/classes/AudioReverb.yaml index 813d946e6..c091f8d62 100644 --- a/content/en-us/reference/engine/classes/AudioReverb.yaml +++ b/content/en-us/reference/engine/classes/AudioReverb.yaml @@ -15,7 +15,7 @@ tags: [] deprecation_message: '' properties: - name: AudioReverb.Bypass - summary: 'If True, audio streams are passed-through unaffected by this effect.' + 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 From f4ad8931fab792fd603873d6a9601cfaabe7b282 Mon Sep 17 00:00:00 2001 From: dandrettarbx <84743954+dandrettarbx@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:41:56 -0700 Subject: [PATCH 10/17] Update content/en-us/reference/engine/classes/AudioReverb.yaml --- content/en-us/reference/engine/classes/AudioReverb.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioReverb.yaml b/content/en-us/reference/engine/classes/AudioReverb.yaml index c091f8d62..f9cc6c5ee 100644 --- a/content/en-us/reference/engine/classes/AudioReverb.yaml +++ b/content/en-us/reference/engine/classes/AudioReverb.yaml @@ -16,7 +16,7 @@ deprecation_message: '' properties: - name: AudioReverb.Bypass summary: 'If true, audio streams are passed-through unaffected by this effect.' - description: '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: [] From f36dc8f8bc7fc1a59f7d43183969ab0ff3861ef8 Mon Sep 17 00:00:00 2001 From: dandrettarbx <84743954+dandrettarbx@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:42:02 -0700 Subject: [PATCH 11/17] Update content/en-us/reference/engine/classes/AudioReverb.yaml --- content/en-us/reference/engine/classes/AudioReverb.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioReverb.yaml b/content/en-us/reference/engine/classes/AudioReverb.yaml index f9cc6c5ee..f1ae7e342 100644 --- a/content/en-us/reference/engine/classes/AudioReverb.yaml +++ b/content/en-us/reference/engine/classes/AudioReverb.yaml @@ -255,7 +255,7 @@ properties: can_save: true methods: - name: AudioReverb:GetConnectedWires - summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin' + 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. From 6bfbae96acda9a9590423f880861d57376fa9a04 Mon Sep 17 00:00:00 2001 From: dandrettarbx <84743954+dandrettarbx@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:42:19 -0700 Subject: [PATCH 12/17] Update content/en-us/reference/engine/classes/AudioChorus.yaml --- content/en-us/reference/engine/classes/AudioChorus.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioChorus.yaml b/content/en-us/reference/engine/classes/AudioChorus.yaml index 885bd0c3c..3e1d46243 100644 --- a/content/en-us/reference/engine/classes/AudioChorus.yaml +++ b/content/en-us/reference/engine/classes/AudioChorus.yaml @@ -21,7 +21,7 @@ tags: [] deprecation_message: '' properties: - name: AudioChorus.Bypass - summary: 'If True, audio streams are passed-through unaffected by this effect.' + 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 From 12c7ec2a52c6b45aa05cb05d0cfa5a4a1fa55ee1 Mon Sep 17 00:00:00 2001 From: dandrettarbx <84743954+dandrettarbx@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:42:30 -0700 Subject: [PATCH 13/17] Update content/en-us/reference/engine/classes/AudioChorus.yaml --- content/en-us/reference/engine/classes/AudioChorus.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioChorus.yaml b/content/en-us/reference/engine/classes/AudioChorus.yaml index 3e1d46243..d6438859f 100644 --- a/content/en-us/reference/engine/classes/AudioChorus.yaml +++ b/content/en-us/reference/engine/classes/AudioChorus.yaml @@ -22,7 +22,7 @@ deprecation_message: '' properties: - name: AudioChorus.Bypass summary: 'If true, audio streams are passed-through unaffected by this effect.' - description: '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: [] From 0d1dd220ce62bbdb66b99d16b5b4a93fd7cd896d Mon Sep 17 00:00:00 2001 From: dandrettarbx <84743954+dandrettarbx@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:42:39 -0700 Subject: [PATCH 14/17] Update content/en-us/reference/engine/classes/AudioChorus.yaml --- content/en-us/reference/engine/classes/AudioChorus.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioChorus.yaml b/content/en-us/reference/engine/classes/AudioChorus.yaml index d6438859f..1107a1034 100644 --- a/content/en-us/reference/engine/classes/AudioChorus.yaml +++ b/content/en-us/reference/engine/classes/AudioChorus.yaml @@ -93,7 +93,7 @@ properties: can_save: true methods: - name: AudioChorus:GetConnectedWires - summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin' + 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. From 5214896e3a4be5f6765b83168915ce1e21bc98e4 Mon Sep 17 00:00:00 2001 From: dandrettarbx <84743954+dandrettarbx@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:42:49 -0700 Subject: [PATCH 15/17] Update content/en-us/reference/engine/classes/AudioCompressor.yaml --- content/en-us/reference/engine/classes/AudioCompressor.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioCompressor.yaml b/content/en-us/reference/engine/classes/AudioCompressor.yaml index da9c2a50f..438b13c45 100644 --- a/content/en-us/reference/engine/classes/AudioCompressor.yaml +++ b/content/en-us/reference/engine/classes/AudioCompressor.yaml @@ -40,7 +40,7 @@ properties: can_load: true can_save: true - name: AudioCompressor.Bypass - summary: 'If True, audio streams are passed-through unaffected by this effect.' + 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 From 44c415867930ce0e13fc58250774644a4cead772 Mon Sep 17 00:00:00 2001 From: dandrettarbx <84743954+dandrettarbx@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:42:59 -0700 Subject: [PATCH 16/17] Update content/en-us/reference/engine/classes/AudioCompressor.yaml --- content/en-us/reference/engine/classes/AudioCompressor.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioCompressor.yaml b/content/en-us/reference/engine/classes/AudioCompressor.yaml index 438b13c45..c0d580136 100644 --- a/content/en-us/reference/engine/classes/AudioCompressor.yaml +++ b/content/en-us/reference/engine/classes/AudioCompressor.yaml @@ -41,7 +41,7 @@ properties: can_save: true - name: AudioCompressor.Bypass summary: 'If true, audio streams are passed-through unaffected by this effect.' - description: '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: [] From 3a94d3ee0f0e7ff4414d1c3ed084282ff3eb0a24 Mon Sep 17 00:00:00 2001 From: dandrettarbx <84743954+dandrettarbx@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:44:22 -0700 Subject: [PATCH 17/17] Apply suggestions from code review --- content/en-us/reference/engine/classes/AudioCompressor.yaml | 2 +- .../en-us/reference/engine/classes/AudioDeviceInput.yaml | 2 +- .../en-us/reference/engine/classes/AudioDeviceOutput.yaml | 2 +- content/en-us/reference/engine/classes/AudioDistortion.yaml | 6 +++--- content/en-us/reference/engine/classes/AudioEcho.yaml | 6 +++--- content/en-us/reference/engine/classes/AudioEmitter.yaml | 2 +- content/en-us/reference/engine/classes/AudioEqualizer.yaml | 6 +++--- content/en-us/reference/engine/classes/AudioFader.yaml | 6 +++--- content/en-us/reference/engine/classes/AudioFilter.yaml | 6 +++--- content/en-us/reference/engine/classes/AudioFlanger.yaml | 6 +++--- content/en-us/reference/engine/classes/AudioListener.yaml | 2 +- .../en-us/reference/engine/classes/AudioPitchShifter.yaml | 4 ++-- 12 files changed, 25 insertions(+), 25 deletions(-) diff --git a/content/en-us/reference/engine/classes/AudioCompressor.yaml b/content/en-us/reference/engine/classes/AudioCompressor.yaml index c0d580136..a62525281 100644 --- a/content/en-us/reference/engine/classes/AudioCompressor.yaml +++ b/content/en-us/reference/engine/classes/AudioCompressor.yaml @@ -144,7 +144,7 @@ properties: can_save: true methods: - name: AudioCompressor:GetConnectedWires - summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin' + 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. diff --git a/content/en-us/reference/engine/classes/AudioDeviceInput.yaml b/content/en-us/reference/engine/classes/AudioDeviceInput.yaml index 25ab8690e..48ee0234d 100644 --- a/content/en-us/reference/engine/classes/AudioDeviceInput.yaml +++ b/content/en-us/reference/engine/classes/AudioDeviceInput.yaml @@ -168,7 +168,7 @@ properties: can_save: true methods: - name: AudioDeviceInput:GetConnectedWires - summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin' + 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. diff --git a/content/en-us/reference/engine/classes/AudioDeviceOutput.yaml b/content/en-us/reference/engine/classes/AudioDeviceOutput.yaml index 78d89d0cf..ef9dbe9ab 100644 --- a/content/en-us/reference/engine/classes/AudioDeviceOutput.yaml +++ b/content/en-us/reference/engine/classes/AudioDeviceOutput.yaml @@ -38,7 +38,7 @@ properties: can_save: true methods: - name: AudioDeviceOutput:GetConnectedWires - summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin' + 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. diff --git a/content/en-us/reference/engine/classes/AudioDistortion.yaml b/content/en-us/reference/engine/classes/AudioDistortion.yaml index 717f0ee8f..c8d1a8107 100644 --- a/content/en-us/reference/engine/classes/AudioDistortion.yaml +++ b/content/en-us/reference/engine/classes/AudioDistortion.yaml @@ -15,8 +15,8 @@ tags: [] deprecation_message: '' properties: - name: AudioDistortion.Bypass - summary: 'If True, audio streams are passed-through unaffected by this effect.' - description: 'If True, audio streams are passed-through unaffected by this effect.' + 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: [] @@ -48,7 +48,7 @@ properties: can_save: true methods: - name: AudioDistortion:GetConnectedWires - summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin' + 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. diff --git a/content/en-us/reference/engine/classes/AudioEcho.yaml b/content/en-us/reference/engine/classes/AudioEcho.yaml index 82f09c2ce..8478ca5e5 100644 --- a/content/en-us/reference/engine/classes/AudioEcho.yaml +++ b/content/en-us/reference/engine/classes/AudioEcho.yaml @@ -15,8 +15,8 @@ tags: [] deprecation_message: '' properties: - name: AudioEcho.Bypass - summary: 'If True, audio streams are passed-through unaffected by this effect.' - description: 'If True, audio streams are passed-through unaffected by this effect.' + 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: [] @@ -104,7 +104,7 @@ properties: can_save: true methods: - name: AudioEcho:GetConnectedWires - summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin' + 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. diff --git a/content/en-us/reference/engine/classes/AudioEmitter.yaml b/content/en-us/reference/engine/classes/AudioEmitter.yaml index 286b1d87e..bf07f2754 100644 --- a/content/en-us/reference/engine/classes/AudioEmitter.yaml +++ b/content/en-us/reference/engine/classes/AudioEmitter.yaml @@ -69,7 +69,7 @@ properties: can_save: true methods: - name: AudioEmitter:GetConnectedWires - summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin' + 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. diff --git a/content/en-us/reference/engine/classes/AudioEqualizer.yaml b/content/en-us/reference/engine/classes/AudioEqualizer.yaml index 0e1cfb45d..058c0fd05 100644 --- a/content/en-us/reference/engine/classes/AudioEqualizer.yaml +++ b/content/en-us/reference/engine/classes/AudioEqualizer.yaml @@ -18,8 +18,8 @@ tags: [] deprecation_message: '' properties: - name: AudioEqualizer.Bypass - summary: 'If True, audio streams are passed-through unaffected by this effect.' - description: 'If True, audio streams are passed-through unaffected by this effect.' + 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: [] @@ -129,7 +129,7 @@ properties: can_save: true methods: - name: AudioEqualizer:GetConnectedWires - summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin' + 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. diff --git a/content/en-us/reference/engine/classes/AudioFader.yaml b/content/en-us/reference/engine/classes/AudioFader.yaml index 392abe487..14f80d570 100644 --- a/content/en-us/reference/engine/classes/AudioFader.yaml +++ b/content/en-us/reference/engine/classes/AudioFader.yaml @@ -15,8 +15,8 @@ tags: [] deprecation_message: '' properties: - name: AudioFader.Bypass - summary: 'If True, audio streams are passed-through unaffected by this effect.' - description: 'If True, audio streams are passed-through unaffected by this effect.' + 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: [] @@ -49,7 +49,7 @@ properties: can_save: true methods: - name: AudioFader:GetConnectedWires - summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin' + 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. diff --git a/content/en-us/reference/engine/classes/AudioFilter.yaml b/content/en-us/reference/engine/classes/AudioFilter.yaml index c8a44a886..97b9c5568 100644 --- a/content/en-us/reference/engine/classes/AudioFilter.yaml +++ b/content/en-us/reference/engine/classes/AudioFilter.yaml @@ -19,8 +19,8 @@ tags: [] deprecation_message: '' properties: - name: AudioFilter.Bypass - summary: 'If True, audio streams are passed-through unaffected by this effect.' - description: 'If True, audio streams are passed-through unaffected by this effect.' + 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: [] @@ -136,7 +136,7 @@ properties: can_save: true methods: - name: AudioFilter:GetConnectedWires - summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin' + 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. diff --git a/content/en-us/reference/engine/classes/AudioFlanger.yaml b/content/en-us/reference/engine/classes/AudioFlanger.yaml index c3cd343a4..ed82fbdba 100644 --- a/content/en-us/reference/engine/classes/AudioFlanger.yaml +++ b/content/en-us/reference/engine/classes/AudioFlanger.yaml @@ -16,8 +16,8 @@ tags: [] deprecation_message: '' properties: - name: AudioFlanger.Bypass - summary: 'If True, audio streams are passed-through unaffected by this effect.' - description: 'If True, audio streams are passed-through unaffected by this effect.' + 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: [] @@ -88,7 +88,7 @@ properties: can_save: true methods: - name: AudioFlanger:GetConnectedWires - summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin' + 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. diff --git a/content/en-us/reference/engine/classes/AudioListener.yaml b/content/en-us/reference/engine/classes/AudioListener.yaml index e15a689b6..2a9ebef10 100644 --- a/content/en-us/reference/engine/classes/AudioListener.yaml +++ b/content/en-us/reference/engine/classes/AudioListener.yaml @@ -68,7 +68,7 @@ properties: can_save: true methods: - name: AudioListener:GetConnectedWires - summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin' + 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. diff --git a/content/en-us/reference/engine/classes/AudioPitchShifter.yaml b/content/en-us/reference/engine/classes/AudioPitchShifter.yaml index 7acc2bc54..08377307c 100644 --- a/content/en-us/reference/engine/classes/AudioPitchShifter.yaml +++ b/content/en-us/reference/engine/classes/AudioPitchShifter.yaml @@ -17,8 +17,8 @@ tags: [] deprecation_message: '' properties: - name: AudioPitchShifter.Bypass - summary: 'If True, audio streams are passed-through unaffected by this effect.' - description: 'If True, audio streams are passed-through unaffected by this effect.' + 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: []