Skip to content

Commit 2164b06

Browse files
AThousandShipsAThousandShips
authored
Merge pull request #10145 from godotengine/classref/sync-61accf0
classref: Sync with current master branch (61accf0)
2 parents d713535 + 85ce5bd commit 2164b06

32 files changed

+612
-89
lines changed

‎classes/[email protected]‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ Built-in GDScript constants, functions, and annotations.
1717
Description
1818
-----------
1919

20-
A list of GDScript-specific utility functions and annotations accessible from any script.
20+
A list of utility functions and annotations accessible from any script written in GDScript.
2121

22-
For the list of the global functions and constants see :ref:`@GlobalScope<class_@GlobalScope>`.
22+
For the list of global functions and constants that can be accessed in any scripting language, see :ref:`@GlobalScope<class_@GlobalScope>`.
2323

2424
.. rst-class:: classref-introduction-group
2525

@@ -43,7 +43,7 @@ Methods
4343
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
4444
| :ref:`String<class_String>` | :ref:`char<class_@GDScript_method_char>`\ (\ char\: :ref:`int<class_int>`\ ) |
4545
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
46-
| :ref:`Variant<class_Variant>` | :ref:`convert<class_@GDScript_method_convert>`\ (\ what\: :ref:`Variant<class_Variant>`, type\: :ref:`int<class_int>`\ ) |
46+
| :ref:`Variant<class_Variant>` | :ref:`convert<class_@GDScript_method_convert>`\ (\ what\: :ref:`Variant<class_Variant>`, type\: :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>`\ ) |
4747
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
4848
| :ref:`Object<class_Object>` | :ref:`dict_to_inst<class_@GDScript_method_dict_to_inst>`\ (\ dictionary\: :ref:`Dictionary<class_Dictionary>`\ ) |
4949
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -958,7 +958,7 @@ Returns a single character (as a :ref:`String<class_String>`) of the given Unico
958958

959959
.. rst-class:: classref-method
960960

961-
:ref:`Variant<class_Variant>` **convert**\ (\ what\: :ref:`Variant<class_Variant>`, type\: :ref:`int<class_int>`\ ) :ref:`🔗<class_@GDScript_method_convert>`
961+
:ref:`Variant<class_Variant>` **convert**\ (\ what\: :ref:`Variant<class_Variant>`, type\: :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>`\ ) :ref:`🔗<class_@GDScript_method_convert>`
962962

963963
**Deprecated:** Use :ref:`@GlobalScope.type_convert<class_@GlobalScope_method_type_convert>` instead.
964964

‎classes/[email protected]‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A list of global scope enumerated constants and built-in functions. This is all
2121

2222
Singletons are also documented here, since they can be accessed from anywhere.
2323

24-
For the entries related to GDScript which can be accessed in any script see :ref:`@GDScript<class_@GDScript>`.
24+
For the entries that can only be accessed from scripts written in GDScript, see :ref:`@GDScript<class_@GDScript>`.
2525

2626
.. note::
2727

‎classes/class_atlastexture.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Description
2323

2424
Multiple **AtlasTexture** resources can be cropped from the same :ref:`atlas<class_AtlasTexture_property_atlas>`. Packing many smaller textures into a singular large texture helps to optimize video memory costs and render calls.
2525

26-
\ **Note:** **AtlasTexture** cannot be used in an :ref:`AnimatedTexture<class_AnimatedTexture>`, and may not tile properly in nodes such as :ref:`TextureRect<class_TextureRect>`, when inside other **AtlasTexture** resources.
26+
\ **Note:** **AtlasTexture** cannot be used in an :ref:`AnimatedTexture<class_AnimatedTexture>`, and will not tile properly in nodes such as :ref:`TextureRect<class_TextureRect>` or :ref:`Sprite2D<class_Sprite2D>`. To tile an **AtlasTexture**, modify its :ref:`region<class_AtlasTexture_property_region>` instead.
2727

2828
.. rst-class:: classref-reftable-group
2929

‎classes/class_audioeffectfilter.rst‎

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -69,47 +69,31 @@ enum **FilterDB**: :ref:`🔗<enum_AudioEffectFilter_FilterDB>`
6969

7070
:ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **FILTER_6DB** = ``0``
7171

72-
.. container:: contribute
73-
74-
There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
75-
76-
72+
Cutting off at 6dB per octave.
7773

7874
.. _class_AudioEffectFilter_constant_FILTER_12DB:
7975

8076
.. rst-class:: classref-enumeration-constant
8177

8278
:ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **FILTER_12DB** = ``1``
8379

84-
.. container:: contribute
85-
86-
There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
87-
88-
80+
Cutting off at 12dB per octave.
8981

9082
.. _class_AudioEffectFilter_constant_FILTER_18DB:
9183

9284
.. rst-class:: classref-enumeration-constant
9385

9486
:ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **FILTER_18DB** = ``2``
9587

96-
.. container:: contribute
97-
98-
There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
99-
100-
88+
Cutting off at 18dB per octave.
10189

10290
.. _class_AudioEffectFilter_constant_FILTER_24DB:
10391

10492
.. rst-class:: classref-enumeration-constant
10593

10694
:ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **FILTER_24DB** = ``3``
10795

108-
.. container:: contribute
109-
110-
There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
111-
112-
96+
Cutting off at 24dB per octave.
11397

11498
.. rst-class:: classref-section-separator
11599

@@ -148,9 +132,7 @@ Threshold frequency for the filter, in Hz.
148132
- |void| **set_db**\ (\ value\: :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>`\ )
149133
- :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **get_db**\ (\ )
150134

151-
.. container:: contribute
152-
153-
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
135+
Steepness of the cutoff curve in dB per octave, also known as the order of the filter. Higher orders have a more aggressive cutoff.
154136

155137
.. rst-class:: classref-item-separator
156138

‎classes/class_audioeffectstereoenhance.rst‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Property Descriptions
6464
- |void| **set_pan_pullout**\ (\ value\: :ref:`float<class_float>`\ )
6565
- :ref:`float<class_float>` **get_pan_pullout**\ (\ )
6666

67-
Values greater than 1.0 increase intensity of any panning on audio passing through this effect, whereas values less than 1.0 will decrease the panning intensity. A value of 0.0 will downmix audio to mono.
67+
Amplifies the difference between stereo channels, increasing or decreasing existing panning. A value of 0.0 will downmix stereo to mono. Does not affect a mono signal.
6868

6969
.. rst-class:: classref-item-separator
7070

@@ -81,9 +81,7 @@ Values greater than 1.0 increase intensity of any panning on audio passing throu
8181
- |void| **set_surround**\ (\ value\: :ref:`float<class_float>`\ )
8282
- :ref:`float<class_float>` **get_surround**\ (\ )
8383

84-
.. container:: contribute
85-
86-
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
84+
Widens sound stage through phase shifting in conjunction with :ref:`time_pullout_ms<class_AudioEffectStereoEnhance_property_time_pullout_ms>`. Just pans sound to the left channel if :ref:`time_pullout_ms<class_AudioEffectStereoEnhance_property_time_pullout_ms>` is 0.
8785

8886
.. rst-class:: classref-item-separator
8987

@@ -100,9 +98,7 @@ Values greater than 1.0 increase intensity of any panning on audio passing throu
10098
- |void| **set_time_pullout**\ (\ value\: :ref:`float<class_float>`\ )
10199
- :ref:`float<class_float>` **get_time_pullout**\ (\ )
102100

103-
.. container:: contribute
104-
105-
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
101+
Widens sound stage through phase shifting in conjunction with :ref:`surround<class_AudioEffectStereoEnhance_property_surround>`. Just delays the right channel if :ref:`surround<class_AudioEffectStereoEnhance_property_surround>` is 0.
106102

107103
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
108104
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`

‎classes/class_audioserver.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ Methods
8787
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
8888
| :ref:`float<class_float>` | :ref:`get_bus_volume_db<class_AudioServer_method_get_bus_volume_db>`\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| |
8989
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
90+
| :ref:`String<class_String>` | :ref:`get_driver_name<class_AudioServer_method_get_driver_name>`\ (\ ) |const| |
91+
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
9092
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_input_device_list<class_AudioServer_method_get_input_device_list>`\ (\ ) |
9193
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
9294
| :ref:`float<class_float>` | :ref:`get_mix_rate<class_AudioServer_method_get_mix_rate>`\ (\ ) |const| |
@@ -514,6 +516,18 @@ Returns the volume of the bus at index ``bus_idx`` in dB.
514516

515517
----
516518

519+
.. _class_AudioServer_method_get_driver_name:
520+
521+
.. rst-class:: classref-method
522+
523+
:ref:`String<class_String>` **get_driver_name**\ (\ ) |const| :ref:`🔗<class_AudioServer_method_get_driver_name>`
524+
525+
Returns the name of the current audio driver. The default usually depends on the operating system, but may be overridden via the ``--audio-driver`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>`. ``--headless`` also automatically sets the audio driver to ``Dummy``. See also :ref:`ProjectSettings.audio/driver/driver<class_ProjectSettings_property_audio/driver/driver>`.
526+
527+
.. rst-class:: classref-item-separator
528+
529+
----
530+
517531
.. _class_AudioServer_method_get_input_device_list:
518532

519533
.. rst-class:: classref-method

‎classes/class_audiostreamplayback.rst‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,24 @@ Methods
5959
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
6060
| |void| | :ref:`_tag_used_streams<class_AudioStreamPlayback_private_method__tag_used_streams>`\ (\ ) |virtual| |
6161
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
62+
| :ref:`int<class_int>` | :ref:`get_loop_count<class_AudioStreamPlayback_method_get_loop_count>`\ (\ ) |const| |
63+
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
64+
| :ref:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayback_method_get_playback_position>`\ (\ ) |const| |
65+
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
6266
| :ref:`AudioSamplePlayback<class_AudioSamplePlayback>` | :ref:`get_sample_playback<class_AudioStreamPlayback_method_get_sample_playback>`\ (\ ) |const| |
6367
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
68+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayback_method_is_playing>`\ (\ ) |const| |
69+
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
70+
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`mix_audio<class_AudioStreamPlayback_method_mix_audio>`\ (\ rate_scale\: :ref:`float<class_float>`, frames\: :ref:`int<class_int>`\ ) |
71+
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
72+
| |void| | :ref:`seek<class_AudioStreamPlayback_method_seek>`\ (\ time\: :ref:`float<class_float>` = 0.0\ ) |
73+
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
6474
| |void| | :ref:`set_sample_playback<class_AudioStreamPlayback_method_set_sample_playback>`\ (\ playback_sample\: :ref:`AudioSamplePlayback<class_AudioSamplePlayback>`\ ) |
6575
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
76+
| |void| | :ref:`start<class_AudioStreamPlayback_method_start>`\ (\ from_pos\: :ref:`float<class_float>` = 0.0\ ) |
77+
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
78+
| |void| | :ref:`stop<class_AudioStreamPlayback_method_stop>`\ (\ ) |
79+
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
6680

6781
.. rst-class:: classref-section-separator
6882

@@ -195,6 +209,30 @@ Overridable method. Called whenever the audio stream is mixed if the playback is
195209

196210
----
197211

212+
.. _class_AudioStreamPlayback_method_get_loop_count:
213+
214+
.. rst-class:: classref-method
215+
216+
:ref:`int<class_int>` **get_loop_count**\ (\ ) |const| :ref:`🔗<class_AudioStreamPlayback_method_get_loop_count>`
217+
218+
Returns the number of times the stream has looped.
219+
220+
.. rst-class:: classref-item-separator
221+
222+
----
223+
224+
.. _class_AudioStreamPlayback_method_get_playback_position:
225+
226+
.. rst-class:: classref-method
227+
228+
:ref:`float<class_float>` **get_playback_position**\ (\ ) |const| :ref:`🔗<class_AudioStreamPlayback_method_get_playback_position>`
229+
230+
Returns the current position in the stream, in seconds.
231+
232+
.. rst-class:: classref-item-separator
233+
234+
----
235+
198236
.. _class_AudioStreamPlayback_method_get_sample_playback:
199237

200238
.. rst-class:: classref-method
@@ -209,6 +247,46 @@ Returns the :ref:`AudioSamplePlayback<class_AudioSamplePlayback>` associated wit
209247

210248
----
211249

250+
.. _class_AudioStreamPlayback_method_is_playing:
251+
252+
.. rst-class:: classref-method
253+
254+
:ref:`bool<class_bool>` **is_playing**\ (\ ) |const| :ref:`🔗<class_AudioStreamPlayback_method_is_playing>`
255+
256+
Returns ``true`` if the stream is playing.
257+
258+
.. rst-class:: classref-item-separator
259+
260+
----
261+
262+
.. _class_AudioStreamPlayback_method_mix_audio:
263+
264+
.. rst-class:: classref-method
265+
266+
:ref:`PackedVector2Array<class_PackedVector2Array>` **mix_audio**\ (\ rate_scale\: :ref:`float<class_float>`, frames\: :ref:`int<class_int>`\ ) :ref:`🔗<class_AudioStreamPlayback_method_mix_audio>`
267+
268+
Mixes up to ``frames`` of audio from the stream from the current position, at a rate of ``rate_scale``, advancing the stream.
269+
270+
Returns a :ref:`PackedVector2Array<class_PackedVector2Array>` where each element holds the left and right channel volume levels of each frame.
271+
272+
\ **Note:** Can return fewer frames than requested, make sure to use the size of the return value.
273+
274+
.. rst-class:: classref-item-separator
275+
276+
----
277+
278+
.. _class_AudioStreamPlayback_method_seek:
279+
280+
.. rst-class:: classref-method
281+
282+
|void| **seek**\ (\ time\: :ref:`float<class_float>` = 0.0\ ) :ref:`🔗<class_AudioStreamPlayback_method_seek>`
283+
284+
Seeks the stream at the given ``time``, in seconds.
285+
286+
.. rst-class:: classref-item-separator
287+
288+
----
289+
212290
.. _class_AudioStreamPlayback_method_set_sample_playback:
213291

214292
.. rst-class:: classref-method
@@ -219,6 +297,30 @@ Returns the :ref:`AudioSamplePlayback<class_AudioSamplePlayback>` associated wit
219297

220298
Associates :ref:`AudioSamplePlayback<class_AudioSamplePlayback>` to this **AudioStreamPlayback** for playing back the audio sample of this stream.
221299

300+
.. rst-class:: classref-item-separator
301+
302+
----
303+
304+
.. _class_AudioStreamPlayback_method_start:
305+
306+
.. rst-class:: classref-method
307+
308+
|void| **start**\ (\ from_pos\: :ref:`float<class_float>` = 0.0\ ) :ref:`🔗<class_AudioStreamPlayback_method_start>`
309+
310+
Starts the stream from the given ``from_pos``, in seconds.
311+
312+
.. rst-class:: classref-item-separator
313+
314+
----
315+
316+
.. _class_AudioStreamPlayback_method_stop:
317+
318+
.. rst-class:: classref-method
319+
320+
|void| **stop**\ (\ ) :ref:`🔗<class_AudioStreamPlayback_method_stop>`
321+
322+
Stops the stream.
323+
222324
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
223325
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
224326
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

0 commit comments

Comments
 (0)