Skip to content

Commit 578b605

Browse files
authored
Merge pull request godotengine#8800 from godotengine/classref/sync-0bcc0e9
classref: Sync with current master branch (0bcc0e9)
2 parents e8b6fb8 + c535239 commit 578b605

File tree

59 files changed

+1311
-176
lines changed

Some content is hidden

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

59 files changed

+1311
-176
lines changed

classes/[email protected]

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -662,7 +662,7 @@ Add a custom icon to the current script. The icon specified at ``icon_path`` is
662662

663663
\ **Note:** As annotations describe their subject, the :ref:`@icon<class_@GDScript_annotation_@icon>` annotation must be placed before the class definition and inheritance.
664664

665-
\ **Note:** Unlike other annotations, the argument of the :ref:`@icon<class_@GDScript_annotation_@icon>` annotation must be a string literal (constant expressions are not supported).
665+
\ **Note:** Unlike most other annotations, the argument of the :ref:`@icon<class_@GDScript_annotation_@icon>` annotation must be a string literal (constant expressions are not supported).
666666

667667
.. rst-class:: classref-item-separator
668668

@@ -748,6 +748,20 @@ Mark the current script as a tool script, allowing it to be loaded and executed
748748

749749
----
750750

751+
.. _class_@GDScript_annotation_@uid:
752+
753+
.. rst-class:: classref-annotation
754+
755+
**@uid** **(** :ref:`String<class_String>` uid **)**
756+
757+
Stores information about UID of this script. This annotation is auto-generated when saving the script and must not be modified manually. Only applies to scripts saved as separate files (i.e. not built-in).
758+
759+
\ **Note:** Unlike most other annotations, the argument of the :ref:`@uid<class_@GDScript_annotation_@uid>` annotation must be a string literal (constant expressions are not supported).
760+
761+
.. rst-class:: classref-item-separator
762+
763+
----
764+
751765
.. _class_@GDScript_annotation_@warning_ignore:
752766

753767
.. rst-class:: classref-annotation

classes/[email protected]

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6408,6 +6408,8 @@ When printing to standard output, the supported subset of BBCode is converted to
64086408

64096409
\ **Note:** On Windows, only Windows 10 and later correctly displays ANSI escape codes in standard output.
64106410

6411+
\ **Note:** Output displayed in the editor supports clickable ``[url=address]text[/url]`` tags. The ``[url]`` tag's ``address`` value is handled by :ref:`OS.shell_open<class_OS_method_shell_open>` when clicked.
6412+
64116413
.. rst-class:: classref-item-separator
64126414

64136415
----

classes/class_aabb.rst

Lines changed: 210 additions & 48 deletions
Large diffs are not rendered by default.

classes/class_animation.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,22 +27,24 @@ This resource holds data that can be used to animate anything in the engine. Ani
2727
.. code-tab:: gdscript
2828

2929
# This creates an animation that makes the node "Enemy" move to the right by
30-
# 100 pixels in 0.5 seconds.
30+
# 100 pixels in 2.0 seconds.
3131
var animation = Animation.new()
3232
var track_index = animation.add_track(Animation.TYPE_VALUE)
3333
animation.track_set_path(track_index, "Enemy:position:x")
3434
animation.track_insert_key(track_index, 0.0, 0)
35-
animation.track_insert_key(track_index, 0.5, 100)
35+
animation.track_insert_key(track_index, 2.0, 100)
36+
animation.length = 2.0
3637

3738
.. code-tab:: csharp
3839

3940
// This creates an animation that makes the node "Enemy" move to the right by
40-
// 100 pixels in 0.5 seconds.
41+
// 100 pixels in 2.0 seconds.
4142
var animation = new Animation();
4243
int trackIndex = animation.AddTrack(Animation.TrackType.Value);
4344
animation.TrackSetPath(trackIndex, "Enemy:position:x");
4445
animation.TrackInsertKey(trackIndex, 0.0f, 0);
45-
animation.TrackInsertKey(trackIndex, 0.5f, 100);
46+
animation.TrackInsertKey(trackIndex, 2.0f, 100);
47+
animation.Length = 2.0f;
4648

4749

4850

classes/class_animationnodestatemachine.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Seeking to the beginning is treated as seeking to the beginning of the animation
146146

147147
:ref:`StateMachineType<enum_AnimationNodeStateMachine_StateMachineType>` **STATE_MACHINE_TYPE_GROUPED** = ``2``
148148

149-
This is a grouped state machine that can be controlled from a parent state machine. It does not work on standalone. There must be a state machine with :ref:`state_machine_type<class_AnimationNodeStateMachine_property_state_machine_type>` of :ref:`STATE_MACHINE_TYPE_ROOT<class_AnimationNodeStateMachine_constant_STATE_MACHINE_TYPE_ROOT>` or :ref:`STATE_MACHINE_TYPE_NESTED<class_AnimationNodeStateMachine_constant_STATE_MACHINE_TYPE_NESTED>` in the parent or ancestor.
149+
This is a grouped state machine that can be controlled from a parent state machine. It does not work independently. There must be a state machine with :ref:`state_machine_type<class_AnimationNodeStateMachine_property_state_machine_type>` of :ref:`STATE_MACHINE_TYPE_ROOT<class_AnimationNodeStateMachine_constant_STATE_MACHINE_TYPE_ROOT>` or :ref:`STATE_MACHINE_TYPE_NESTED<class_AnimationNodeStateMachine_constant_STATE_MACHINE_TYPE_NESTED>` in the parent or ancestor.
150150

151151
.. rst-class:: classref-section-separator
152152

classes/class_array.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -936,7 +936,7 @@ Returns a random value from the target array. Prints an error and returns ``null
936936

937937
:ref:`Variant<class_Variant>` **pop_at** **(** :ref:`int<class_int>` position **)**
938938

939-
Removes and returns the element of the array at index ``position``. If negative, ``position`` is considered relative to the end of the array. Leaves the array untouched and returns ``null`` if the array is empty or if it's accessed out of bounds. An error message is printed when the array is accessed out of bounds, but not when the array is empty.
939+
Removes and returns the element of the array at index ``position``. If negative, ``position`` is considered relative to the end of the array. Leaves the array unchanged and returns ``null`` if the array is empty or if it's accessed out of bounds. An error message is printed when the array is accessed out of bounds, but not when the array is empty.
940940

941941
\ **Note:** On large arrays, this method can be slower than :ref:`pop_back<class_Array_method_pop_back>` as it will reindex the array's elements that are located after the removed element. The larger the array and the lower the index of the removed element, the slower :ref:`pop_at<class_Array_method_pop_at>` will be.
942942

classes/class_audioeffectdistortion.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,10 @@ Digital distortion effect which cuts off peaks at the top and bottom of the wave
8181

8282
:ref:`Mode<enum_AudioEffectDistortion_Mode>` **MODE_ATAN** = ``1``
8383

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+
8488

8589

8690
.. _class_AudioEffectDistortion_constant_MODE_LOFI:

classes/class_audioeffectfilter.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@ enum **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+
7276

7377

7478
.. _class_AudioEffectFilter_constant_FILTER_12DB:
@@ -77,6 +81,10 @@ enum **FilterDB**:
7781

7882
:ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **FILTER_12DB** = ``1``
7983

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+
8088

8189

8290
.. _class_AudioEffectFilter_constant_FILTER_18DB:
@@ -85,6 +93,10 @@ enum **FilterDB**:
8593

8694
:ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **FILTER_18DB** = ``2``
8795

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+
88100

89101

90102
.. _class_AudioEffectFilter_constant_FILTER_24DB:
@@ -93,6 +105,10 @@ enum **FilterDB**:
93105

94106
:ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **FILTER_24DB** = ``3``
95107

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+
96112

97113

98114
.. rst-class:: classref-section-separator

classes/class_audioeffectpitchshift.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ The oversampling factor to use. Higher values result in better quality, but are
163163
- void **set_pitch_scale** **(** :ref:`float<class_float>` value **)**
164164
- :ref:`float<class_float>` **get_pitch_scale** **(** **)**
165165

166-
The pitch scale to use. ``1.0`` is the default pitch and plays sounds unaltered. :ref:`pitch_scale<class_AudioEffectPitchShift_property_pitch_scale>` can range from ``0.0`` (infinitely low pitch, inaudible) to ``16`` (16 times higher than the initial pitch).
166+
The pitch scale to use. ``1.0`` is the default pitch and plays sounds unaffected. :ref:`pitch_scale<class_AudioEffectPitchShift_property_pitch_scale>` can range from ``0.0`` (infinitely low pitch, inaudible) to ``16`` (16 times higher than the initial pitch).
167167

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

classes/class_audiostream.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ Methods
5151
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
5252
| :ref:`float<class_float>` | :ref:`_get_length<class_AudioStream_private_method__get_length>` **(** **)** |virtual| |const| |
5353
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
54+
| :ref:`Dictionary[]<class_Dictionary>` | :ref:`_get_parameter_list<class_AudioStream_private_method__get_parameter_list>` **(** **)** |virtual| |const| |
55+
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
5456
| :ref:`String<class_String>` | :ref:`_get_stream_name<class_AudioStream_private_method__get_stream_name>` **(** **)** |virtual| |const| |
5557
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
5658
| :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` | :ref:`_instantiate_playback<class_AudioStream_private_method__instantiate_playback>` **(** **)** |virtual| |const| |
@@ -70,6 +72,23 @@ Methods
7072

7173
.. rst-class:: classref-descriptions-group
7274

75+
Signals
76+
-------
77+
78+
.. _class_AudioStream_signal_parameter_list_changed:
79+
80+
.. rst-class:: classref-signal
81+
82+
**parameter_list_changed** **(** **)**
83+
84+
Signal to be emitted to notify when the parameter list changed.
85+
86+
.. rst-class:: classref-section-separator
87+
88+
----
89+
90+
.. rst-class:: classref-descriptions-group
91+
7392
Method Descriptions
7493
-------------------
7594

@@ -115,6 +134,18 @@ Method Descriptions
115134

116135
----
117136

137+
.. _class_AudioStream_private_method__get_parameter_list:
138+
139+
.. rst-class:: classref-method
140+
141+
:ref:`Dictionary[]<class_Dictionary>` **_get_parameter_list** **(** **)** |virtual| |const|
142+
143+
Return the controllable parameters of this stream. This array contains dictionaries with a property info description format (see :ref:`Object.get_property_list<class_Object_method_get_property_list>`). Additionally, the default value for this parameter must be added tho each dictionary in "default_value" field.
144+
145+
.. rst-class:: classref-item-separator
146+
147+
----
148+
118149
.. _class_AudioStream_private_method__get_stream_name:
119150

120151
.. rst-class:: classref-method

0 commit comments

Comments
 (0)