From ae0bc06ebaceeed2a384164470f4f73a10b2e586 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Sun, 26 Apr 2020 16:37:22 +0200 Subject: [PATCH] Improve `pitch_scale` descriptions in AudioStreamPlayer documentation This closes #29439. Co-authored-by: Cheeseness (cherry picked from commit 4751dee7f414181201e10a0b82e0e3477c740a21) --- doc/classes/AudioStreamPlayer.xml | 2 +- doc/classes/AudioStreamPlayer2D.xml | 2 +- doc/classes/AudioStreamPlayer3D.xml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index f57dbf7a50e..e153b5667dc 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -61,7 +61,7 @@ If the audio configuration has more than two speakers, this sets the target channels. See [enum MixTarget] constants. - Changes the pitch and the tempo of the audio. + The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate. If [code]true[/code], audio is playing. diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index 0f30a3188dd..6733148edc0 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -67,7 +67,7 @@ Maximum distance from which audio is still hearable. - Changes the pitch and the tempo of the audio. + The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate. If [code]true[/code], audio is playing. diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 72d6d0dfe4d..c6b23b380b0 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -91,7 +91,7 @@ Decides if audio should pause when source is outside of [member max_distance] range. - Changes the pitch and the tempo of the audio. + The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate. If [code]true[/code], audio is playing.