godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
c0fed1d4e8
godot/doc/classes/AudioStreamPlayer2D.xml

94 lines
4.6 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="AudioStreamPlayer2D" inherits="Node2D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Improve the AudioStreamPlayer(2D/3D) class descriptions
2021-05-05 18:37:35 +00:00
Plays positional sound in 2D space.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Added Documentation of AudioStreamPlayer2D Fixxed according to comments Somehow that fix was messed up again Forgot some quotationmarks updated autoplay, tried again
2017-09-16 17:31:43 +00:00
Plays audio that dampens with distance from screen center.
Improve the AudioStreamPlayer(2D/3D) class descriptions
2021-05-05 18:37:35 +00:00
See also [AudioStreamPlayer] to play a sound non-positionally.
[b]Note:[/b] Hiding an [AudioStreamPlayer2D] node does not disable its audio output. To temporarily disable an [AudioStreamPlayer2D]'s audio output, set [member volume_db] to a very low value like [code]-100[/code] (which isn't audible to human hearing).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 09:43:07 +00:00
<link title="Audio streams">$DOCS_URL/tutorials/audio/audio_streams.html</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</tutorials>
<methods>
Rename get_position => get_playback_position and seek_pos => seek on audio classes
2017-09-21 03:31:36 +00:00
<method name="get_playback_position">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename get_position => get_playback_position and seek_pos => seek on audio classes
2017-09-21 03:31:36 +00:00
<description>
updated AudioStream docs and added AudioServer docs
2017-10-10 14:00:10 +00:00
Returns the position in the [AudioStream].
Rename get_position => get_playback_position and seek_pos => seek on audio classes
2017-09-21 03:31:36 +00:00
</description>
</method>
doc: Sync classref with current source
2019-04-15 12:49:41 +00:00
<method name="get_stream_playback">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="AudioStreamPlayback" />
doc: Sync classref with current source
2019-04-15 12:49:41 +00:00
<description>
Complete documentation of various classes
2020-01-08 21:51:16 +00:00
Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer2D].
doc: Sync classref with current source
2019-04-15 12:49:41 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="play">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="from_position" type="float" default="0.0" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Plays the audio from the given position [code]from_position[/code], in seconds.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="seek">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="to_position" type="float" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Added Documentation of AudioStreamPlayer2D Fixxed according to comments Somehow that fix was messed up again Forgot some quotationmarks updated autoplay, tried again
2017-09-16 17:31:43 +00:00
Sets the position from which audio will be played, in seconds.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="stop">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Added Documentation of AudioStreamPlayer2D Fixxed according to comments Somehow that fix was messed up again Forgot some quotationmarks updated autoplay, tried again
2017-09-16 17:31:43 +00:00
Stops the audio.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="area_mask" type="int" setter="set_area_mask" getter="get_area_mask" default="1">
Improve the `AudioStreamPlayer2D/3D.area_mask` documentation The documentation was stating that the area mask affects where sounds can be heard, which is not true. Instead, the area mask affects audio bus redirection. Thanks to Azedaxen on the Godot forums for providing this description :)
2022-02-10 22:25:33 +00:00
Determines which [Area2D] layers affect the sound for reverb and audio bus effects. Areas can be used to redirect [AudioStream]s so that they play in a certain audio bus. An example of how you might use this is making a "water" area so that sounds played in the water are redirected through an audio bus to make them sound like they are being played underwater.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="attenuation" type="float" setter="set_attenuation" getter="get_attenuation" default="1.0">
Added Documentation of AudioStreamPlayer2D Fixxed according to comments Somehow that fix was messed up again Forgot some quotationmarks updated autoplay, tried again
2017-09-16 17:31:43 +00:00
Dampens audio over distance with this as an exponent.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 13:24:23 +00:00
If [code]true[/code], audio plays when added to scene tree.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Let var2str display StringName with correct sigil
2021-06-05 19:24:24 +00:00
<member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="&amp;&quot;Master&quot;">
Added Documentation of AudioStreamPlayer2D Fixxed according to comments Somehow that fix was messed up again Forgot some quotationmarks updated autoplay, tried again
2017-09-16 17:31:43 +00:00
Bus on which this audio is playing.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance" default="2000.0">
Added Documentation of AudioStreamPlayer2D Fixxed according to comments Somehow that fix was messed up again Forgot some quotationmarks updated autoplay, tried again
2017-09-16 17:31:43 +00:00
Maximum distance from which audio is still hearable.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Add polyphony to Audio Stream Player nodes
2021-08-28 04:51:03 +00:00
<member name="max_polyphony" type="int" setter="set_max_polyphony" getter="get_max_polyphony" default="1">
The maximum number of sounds this node can play at the same time. Playing additional sounds after this value is reached will cut off the oldest sounds.
</member>
Audio: Expose 2D/3D panning strength parameters
2022-03-06 16:53:56 +00:00
<member name="panning_strength" type="float" setter="set_panning_strength" getter="get_panning_strength" default="1.0">
Scales the panning strength for this node by multiplying the base [member ProjectSettings.audio/general/2d_panning_strength] with this factor. Higher values will pan audio from left to right more dramatically than lower values.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0">
Improve `pitch_scale` descriptions in AudioStreamPlayer documentation This closes #29439. Co-authored-by: Cheeseness <contact@jbushproductions.com>
2020-04-26 14:37:22 +00:00
The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate.
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false">
doc: Add missing commas after "If true/false"
2018-12-20 12:46:54 +00:00
If [code]true[/code], audio is playing.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="stream" type="AudioStream" setter="set_stream" getter="get_stream">
Added Documentation of AudioStreamPlayer2D Fixxed according to comments Somehow that fix was messed up again Forgot some quotationmarks updated autoplay, tried again
2017-09-16 17:31:43 +00:00
The [AudioStream] object to be played.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="stream_paused" type="bool" setter="set_stream_paused" getter="get_stream_paused" default="false">
Complete documentation of various classes
2020-01-08 21:51:16 +00:00
If [code]true[/code], the playback is paused. You can resume it by setting [code]stream_paused[/code] to [code]false[/code].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 09:56:21 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db" default="0.0">
Added Documentation of AudioStreamPlayer2D Fixxed according to comments Somehow that fix was messed up again Forgot some quotationmarks updated autoplay, tried again
2017-09-16 17:31:43 +00:00
Base volume without dampening.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
</members>
<signals>
<signal name="finished">
<description>
Added Documentation of AudioStreamPlayer2D Fixxed according to comments Somehow that fix was messed up again Forgot some quotationmarks updated autoplay, tried again
2017-09-16 17:31:43 +00:00
Emitted when the audio stops playing.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
</signals>
</class>
Reference in New Issue Copy Permalink