diff --git a/content/en-us/reference/engine/classes/AudioAnalyzer.yaml b/content/en-us/reference/engine/classes/AudioAnalyzer.yaml index 71c966883..af79cbc17 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 the `Class.AudioAnalyzer` is dramatically reduced. + This means that if you are only analyzing the **volume** of an audio stream, + you can disable this property 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..1107a1034 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..a62525281 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..48ee0234d 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..ef9dbe9ab 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..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: '' - 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..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: '' - 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..bf07f2754 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..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: '' - 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..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: '' - 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..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: '' - 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..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: '' - 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..2a9ebef10 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..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: '' - 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..84de01dd3 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..f1ae7e342 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