asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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

Browse source 
Supersedes #39605.
Fixes #39585.

(cherry picked from commit eedb729771)
This commit is contained in:
Rémi Verschelde 2022-07-08 09:33:25 +02:00
parent 861e155543
commit 685cecbd5f
3 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
doc/classes/AudioStreamPlayer.xml
View file

@ -55,6 +55,7 @@
</member> </member>
<member name="bus" type="String" setter="set_bus" getter="get_bus" default="&quot;Master&quot;"> <member name="bus" type="String" setter="set_bus" getter="get_bus" default="&quot;Master&quot;">
Bus on which this audio is playing. 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>
<member name="mix_target" type="int" setter="set_mix_target" getter="get_mix_target" enum="AudioStreamPlayer.MixTarget" default="0"> <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. If the audio configuration has more than two speakers, this sets the target channels. See [enum MixTarget] constants.

1
doc/classes/AudioStreamPlayer2D.xml
View file

@ -57,6 +57,7 @@
</member> </member>
<member name="bus" type="String" setter="set_bus" getter="get_bus" default="&quot;Master&quot;"> <member name="bus" type="String" setter="set_bus" getter="get_bus" default="&quot;Master&quot;">
Bus on which this audio is playing. 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>
<member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance" default="2000.0"> <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. Maximum distance from which audio is still hearable.

1
doc/classes/AudioStreamPlayer3D.xml
View file

@ -64,6 +64,7 @@
</member> </member>
<member name="bus" type="String" setter="set_bus" getter="get_bus" default="&quot;Master&quot;"> <member name="bus" type="String" setter="set_bus" getter="get_bus" default="&quot;Master&quot;">
The bus on which this audio is playing. 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>
<member name="doppler_tracking" type="int" setter="set_doppler_tracking" getter="get_doppler_tracking" enum="AudioStreamPlayer3D.DopplerTracking" default="0"> <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. Decides in which step the [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] should be calculated.