Переглянути джерело

AudioStreamPlayer: Clarify that no validation is made on 'bus' name

Supersedes #39605.
Fixes #39585.

(cherry picked from commit eedb72977140c5d7c2d51a11f72c6e6955d95273)
Rémi Verschelde 3 роки тому
батько
коміт
685cecbd5f

+ 1 - 0
doc/classes/AudioStreamPlayer.xml

@@ -55,6 +55,7 @@
 		</member>
 		<member name="bus" type="String" setter="set_bus" getter="get_bus" default="&quot;Master&quot;">
 			Bus on which this audio is playing.
+			[b]Note:[/b] When setting this property, keep in mind that no validation is performed to see if the given name matches an existing bus. This is because audio bus layouts might be loaded after this property is set. If this given name can't be resolved at runtime, it will fall back to [code]"Master"[/code].
 		</member>
 		<member name="mix_target" type="int" setter="set_mix_target" getter="get_mix_target" enum="AudioStreamPlayer.MixTarget" default="0">
 			If the audio configuration has more than two speakers, this sets the target channels. See [enum MixTarget] constants.

+ 1 - 0
doc/classes/AudioStreamPlayer2D.xml

@@ -57,6 +57,7 @@
 		</member>
 		<member name="bus" type="String" setter="set_bus" getter="get_bus" default="&quot;Master&quot;">
 			Bus on which this audio is playing.
+			[b]Note:[/b] When setting this property, keep in mind that no validation is performed to see if the given name matches an existing bus. This is because audio bus layouts might be loaded after this property is set. If this given name can't be resolved at runtime, it will fall back to [code]"Master"[/code].
 		</member>
 		<member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance" default="2000.0">
 			Maximum distance from which audio is still hearable.

+ 1 - 0
doc/classes/AudioStreamPlayer3D.xml

@@ -64,6 +64,7 @@
 		</member>
 		<member name="bus" type="String" setter="set_bus" getter="get_bus" default="&quot;Master&quot;">
 			The bus on which this audio is playing.
+			[b]Note:[/b] When setting this property, keep in mind that no validation is performed to see if the given name matches an existing bus. This is because audio bus layouts might be loaded after this property is set. If this given name can't be resolved at runtime, it will fall back to [code]"Master"[/code].
 		</member>
 		<member name="doppler_tracking" type="int" setter="set_doppler_tracking" getter="get_doppler_tracking" enum="AudioStreamPlayer3D.DopplerTracking" default="0">
 			Decides in which step the [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] should be calculated.