Skip to content

Commit 540b9b9

Browse files
authored
Merge pull request #11536 from godotengine/classref/sync-4b6c88d
classref: Sync with current master branch (4b6c88d)
2 parents 5922871 + d45f83b commit 540b9b9

File tree

119 files changed

+2593
-1638
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

119 files changed

+2593
-1638
lines changed

classes/[email protected]

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -631,7 +631,7 @@ See also :ref:`@GlobalScope.PROPERTY_USAGE_GROUP<class_@GlobalScope_constant_PRO
631631

632632
.. rst-class:: classref-annotation
633633

634-
**@export_multiline**\ (\ ) :ref:`🔗<class_@GDScript_annotation_@export_multiline>`
634+
**@export_multiline**\ (\ hint\: :ref:`String<class_String>` = "", ...\ ) |vararg| :ref:`🔗<class_@GDScript_annotation_@export_multiline>`
635635

636636
Export a :ref:`String<class_String>`, :ref:`Array<class_Array>`\ \[:ref:`String<class_String>`\ \], :ref:`PackedStringArray<class_PackedStringArray>`, :ref:`Dictionary<class_Dictionary>` or :ref:`Array<class_Array>`\ \[:ref:`Dictionary<class_Dictionary>`\ \] property with a large :ref:`TextEdit<class_TextEdit>` widget instead of a :ref:`LineEdit<class_LineEdit>`. This adds support for multiline content and makes it easier to edit large amount of text stored in the property.
637637

@@ -641,6 +641,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_MULTILINE_TEXT<class_@GlobalScope_cons
641641

642642
@export_multiline var character_biography
643643
@export_multiline var npc_dialogs: Array[String]
644+
@export_multiline("monospace", "no_wrap") var favorite_ascii_art: String
644645

645646
.. rst-class:: classref-item-separator
646647

classes/[email protected]

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3633,6 +3633,10 @@ Hints that a property is an instance of a :ref:`Resource<class_Resource>`-derive
36333633

36343634
Hints that a :ref:`String<class_String>` property is text with line breaks. Editing it will show a text input field where line breaks can be typed.
36353635

3636+
The hint string can be set to ``"monospace"`` to force the input field to use a monospaced font.
3637+
3638+
If the hint string ``"no_wrap"`` is set, the input field will not wrap lines at boundaries, instead resorting to making the area scrollable.
3639+
36363640
.. _class_@GlobalScope_constant_PROPERTY_HINT_EXPRESSION:
36373641

36383642
.. rst-class:: classref-enumeration-constant
@@ -7446,7 +7450,7 @@ Returns the internal type of the given ``variable``, using the :ref:`Variant.Typ
74467450
var json = JSON.new()
74477451
json.parse('["a", "b", "c"]')
74487452
var result = json.get_data()
7449-
if result is Array:
7453+
if typeof(result) == TYPE_ARRAY:
74507454
print(result[0]) # Prints "a"
74517455
else:
74527456
print("Unexpected result!")

classes/class_animationnodeoneshot.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ Properties
8989
.. table::
9090
:widths: auto
9191

92+
+---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
93+
| :ref:`bool<class_bool>` | :ref:`abort_on_reset<class_AnimationNodeOneShot_property_abort_on_reset>` | ``false`` |
9294
+---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
9395
| :ref:`bool<class_bool>` | :ref:`autorestart<class_AnimationNodeOneShot_property_autorestart>` | ``false`` |
9496
+---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
@@ -191,6 +193,23 @@ Blends two animations additively. See also :ref:`AnimationNodeAdd2<class_Animati
191193
Property Descriptions
192194
---------------------
193195

196+
.. _class_AnimationNodeOneShot_property_abort_on_reset:
197+
198+
.. rst-class:: classref-property
199+
200+
:ref:`bool<class_bool>` **abort_on_reset** = ``false`` :ref:`🔗<class_AnimationNodeOneShot_property_abort_on_reset>`
201+
202+
.. rst-class:: classref-property-setget
203+
204+
- |void| **set_abort_on_reset**\ (\ value\: :ref:`bool<class_bool>`\ )
205+
- :ref:`bool<class_bool>` **is_aborted_on_reset**\ (\ )
206+
207+
If ``true``, the sub-animation will abort if resumed with a reset after a prior interruption.
208+
209+
.. rst-class:: classref-item-separator
210+
211+
----
212+
194213
.. _class_AnimationNodeOneShot_property_autorestart:
195214

196215
.. rst-class:: classref-property

classes/class_array.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -685,7 +685,7 @@ If ``deep`` is ``true``, a **deep** copy is returned: all nested arrays and dict
685685

686686
:ref:`Array<class_Array>` **duplicate_deep**\ (\ deep_subresources_mode\: :ref:`int<class_int>` = 1\ ) |const| :ref:`🔗<class_Array_method_duplicate_deep>`
687687

688-
Duplicates this array, deeply, like :ref:`duplicate()<class_Array_method_duplicate>`\ ``(true)``, with extra control over how subresources are handled.
688+
Duplicates this array, deeply, like :ref:`duplicate()<class_Array_method_duplicate>` when passing ``true``, with extra control over how subresources are handled.
689689

690690
\ ``deep_subresources_mode`` must be one of the values from :ref:`DeepDuplicateMode<enum_Resource_DeepDuplicateMode>`. By default, only internal resources will be duplicated (recursively).
691691

@@ -836,7 +836,7 @@ Returns the first element of the array. If the array is empty, fails and returns
836836

837837
:ref:`Variant<class_Variant>` **get**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_Array_method_get>`
838838

839-
Returns the element at the given ``index`` in the array. If ``index`` out-of-bounds or negative, this method fails and returns ``null``.
839+
Returns the element at the given ``index`` in the array. If ``index`` is out-of-bounds or negative, this method fails and returns ``null``.
840840

841841
This method is similar (but not identical) to the ``[]`` operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
842842

classes/class_audioserver.rst

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,14 @@ Methods
9191
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
9292
| :ref:`String<class_String>` | :ref:`get_driver_name<class_AudioServer_method_get_driver_name>`\ (\ ) |const| |
9393
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
94+
| :ref:`int<class_int>` | :ref:`get_input_buffer_length_frames<class_AudioServer_method_get_input_buffer_length_frames>`\ (\ ) |
95+
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
9496
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_input_device_list<class_AudioServer_method_get_input_device_list>`\ (\ ) |
9597
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
98+
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`get_input_frames<class_AudioServer_method_get_input_frames>`\ (\ frames\: :ref:`int<class_int>`\ ) |
99+
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
100+
| :ref:`int<class_int>` | :ref:`get_input_frames_available<class_AudioServer_method_get_input_frames_available>`\ (\ ) |
101+
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
96102
| :ref:`float<class_float>` | :ref:`get_input_mix_rate<class_AudioServer_method_get_input_mix_rate>`\ (\ ) |const| |
97103
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
98104
| :ref:`float<class_float>` | :ref:`get_mix_rate<class_AudioServer_method_get_mix_rate>`\ (\ ) |const| |
@@ -147,6 +153,8 @@ Methods
147153
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
148154
| |void| | :ref:`set_enable_tagging_used_audio_streams<class_AudioServer_method_set_enable_tagging_used_audio_streams>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
149155
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
156+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`set_input_device_active<class_AudioServer_method_set_input_device_active>`\ (\ active\: :ref:`bool<class_bool>`\ ) |
157+
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
150158
| |void| | :ref:`swap_bus_effects<class_AudioServer_method_swap_bus_effects>`\ (\ bus_idx\: :ref:`int<class_int>`, effect_idx\: :ref:`int<class_int>`, by_effect_idx\: :ref:`int<class_int>`\ ) |
151159
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
152160
| |void| | :ref:`unlock<class_AudioServer_method_unlock>`\ (\ ) |
@@ -548,6 +556,20 @@ Returns the name of the current audio driver. The default usually depends on the
548556

549557
----
550558

559+
.. _class_AudioServer_method_get_input_buffer_length_frames:
560+
561+
.. rst-class:: classref-method
562+
563+
:ref:`int<class_int>` **get_input_buffer_length_frames**\ (\ ) :ref:`🔗<class_AudioServer_method_get_input_buffer_length_frames>`
564+
565+
**Experimental:** This method may be changed or removed in future versions.
566+
567+
Returns the absolute size of the microphone input buffer. This is set to a multiple of the audio latency and can be used to estimate the minimum rate at which the frames need to be fetched.
568+
569+
.. rst-class:: classref-item-separator
570+
571+
----
572+
551573
.. _class_AudioServer_method_get_input_device_list:
552574

553575
.. rst-class:: classref-method
@@ -562,6 +584,38 @@ Returns the names of all audio input devices detected on the system.
562584

563585
----
564586

587+
.. _class_AudioServer_method_get_input_frames:
588+
589+
.. rst-class:: classref-method
590+
591+
:ref:`PackedVector2Array<class_PackedVector2Array>` **get_input_frames**\ (\ frames\: :ref:`int<class_int>`\ ) :ref:`🔗<class_AudioServer_method_get_input_frames>`
592+
593+
**Experimental:** This method may be changed or removed in future versions.
594+
595+
Returns a :ref:`PackedVector2Array<class_PackedVector2Array>` containing exactly ``frames`` audio samples from the internal microphone buffer if available, otherwise returns an empty :ref:`PackedVector2Array<class_PackedVector2Array>`.
596+
597+
The buffer is filled at the rate of :ref:`get_input_mix_rate()<class_AudioServer_method_get_input_mix_rate>` frames per second when :ref:`set_input_device_active()<class_AudioServer_method_set_input_device_active>` has successfully been set to ``true``.
598+
599+
The samples are signed floating-point PCM values between ``-1`` and ``1``.
600+
601+
.. rst-class:: classref-item-separator
602+
603+
----
604+
605+
.. _class_AudioServer_method_get_input_frames_available:
606+
607+
.. rst-class:: classref-method
608+
609+
:ref:`int<class_int>` **get_input_frames_available**\ (\ ) :ref:`🔗<class_AudioServer_method_get_input_frames_available>`
610+
611+
**Experimental:** This method may be changed or removed in future versions.
612+
613+
Returns the number of frames available to read using :ref:`get_input_frames()<class_AudioServer_method_get_input_frames>`.
614+
615+
.. rst-class:: classref-item-separator
616+
617+
----
618+
565619
.. _class_AudioServer_method_get_input_mix_rate:
566620

567621
.. rst-class:: classref-method
@@ -902,6 +956,22 @@ If set to ``true``, all instances of :ref:`AudioStreamPlayback<class_AudioStream
902956

903957
----
904958

959+
.. _class_AudioServer_method_set_input_device_active:
960+
961+
.. rst-class:: classref-method
962+
963+
:ref:`Error<enum_@GlobalScope_Error>` **set_input_device_active**\ (\ active\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_AudioServer_method_set_input_device_active>`
964+
965+
**Experimental:** This method may be changed or removed in future versions.
966+
967+
If ``active`` is ``true``, starts the microphone input stream specified by :ref:`input_device<class_AudioServer_property_input_device>` or returns an error if it failed.
968+
969+
If ``active`` is ``false``, stops the input stream if it is running.
970+
971+
.. rst-class:: classref-item-separator
972+
973+
----
974+
905975
.. _class_AudioServer_method_swap_bus_effects:
906976

907977
.. rst-class:: classref-method

classes/class_audiostreammp3.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
.. DO NOT EDIT THIS FILE!!!
44
.. Generated automatically from Godot engine sources.
55
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
6-
.. XML source: https://github.com/godotengine/godot/tree/master/modules/minimp3/doc_classes/AudioStreamMP3.xml.
6+
.. XML source: https://github.com/godotengine/godot/tree/master/modules/mp3/doc_classes/AudioStreamMP3.xml.
77
88
.. _class_AudioStreamMP3:
99

classes/class_audiostreamrandomizer.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Controls how this AudioStreamRandomizer picks which AudioStream to play next.
141141
- |void| **set_random_pitch**\ (\ value\: :ref:`float<class_float>`\ )
142142
- :ref:`float<class_float>` **get_random_pitch**\ (\ )
143143

144-
The largest possible frequency multiplier of the random pitch variation. A value of ``1.0`` means no variation.
144+
The largest possible frequency multiplier of the random pitch variation. Pitch will be randomly chosen within a range of ``1.0 / random_pitch`` and ``random_pitch``. A value of ``1.0`` means no variation. A value of ``2.0`` means pitch will be randomized between double and half.
145145

146146
\ **Note:** Setting this property also sets :ref:`random_pitch_semitones<class_AudioStreamRandomizer_property_random_pitch_semitones>`.
147147

@@ -179,7 +179,7 @@ The largest possible distance, in semitones, of the random pitch variation. A va
179179
- |void| **set_random_volume_offset_db**\ (\ value\: :ref:`float<class_float>`\ )
180180
- :ref:`float<class_float>` **get_random_volume_offset_db**\ (\ )
181181

182-
The intensity of random volume variation. A value of 0 means no variation.
182+
The intensity of random volume variation. Volume will be increased or decreased by a random value up to ``random_volume_offset_db``. A value of ``0.0`` means no variation. A value of ``3.0`` means volume will be randomized between ``-3.0 dB`` and ``+3.0 dB``.
183183

184184
.. rst-class:: classref-item-separator
185185

0 commit comments

Comments
 (0)