diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-04-27 10:00:02 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-27 10:00:02 +0200 |
| commit | 7f384e703bdaa813418d2230aa772c89bfce323d (patch) | |
| tree | 5d55248874fa8fa194a346ffeb3e487a919c0c1e /doc | |
| parent | 41a320c82719c8201301459338a8eb47752d864d (diff) | |
| parent | 4751dee7f414181201e10a0b82e0e3477c740a21 (diff) | |
Merge pull request #38230 from Calinou/doc-audiostreamplayer-improve-pitch-scale
Improve `pitch_scale` descriptions in AudioStreamPlayer documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/AudioStreamPlayer.xml | 2 | ||||
| -rw-r--r-- | doc/classes/AudioStreamPlayer2D.xml | 2 | ||||
| -rw-r--r-- | 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 eab6505734..dbc3d3e21b 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. </member> <member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0"> - 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. </member> <member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false"> If [code]true[/code], audio is playing. diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index fdbef1b89e..844e2316ba 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -67,7 +67,7 @@ Maximum distance from which audio is still hearable. </member> <member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0"> - 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. </member> <member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false"> If [code]true[/code], audio is playing. diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 3eeb524e9c..bd90e3bd1a 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. </member> <member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0"> - 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. </member> <member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false"> If [code]true[/code], audio is playing. |