summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2021-09-17 10:14:32 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2021-09-25 12:24:30 +0200
commitb3831818511f7a88329a96c2337338bee1c955a4 (patch)
treed43281cac4317760df922445c3e3fd1b45216ddc /doc
parent53306cb79a32b4d0db7c267e9e01771212766316 (diff)
downloadredot-engine-b3831818511f7a88329a96c2337338bee1c955a4.tar.gz
Tweak AudioStreamPlayer3D property hints for usability
This also improves the documentation for the `max_distance` property.
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/AudioStreamPlayer3D.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml
index bd344fad29..e8a78d5a4c 100644
--- a/doc/classes/AudioStreamPlayer3D.xml
+++ b/doc/classes/AudioStreamPlayer3D.xml
@@ -123,7 +123,7 @@
Logarithmic dampening of loudness according to distance.
</constant>
<constant name="ATTENUATION_DISABLED" value="3" enum="AttenuationModel">
- No dampening of loudness according to distance. The sound will still be heard positionally, unlike an [AudioStreamPlayer].
+ No dampening of loudness according to distance. The sound will still be heard positionally, unlike an [AudioStreamPlayer]. [constant ATTENUATION_DISABLED] can be combined with a [member max_distance] value greater than [code]0.0[/code] to achieve linear attenuation clamped to a sphere of a defined size.
</constant>
<constant name="DOPPLER_TRACKING_DISABLED" value="0" enum="DopplerTracking">
Disables doppler tracking.