Skip to content

Commit 99175ce

Browse files
authored
Merge pull request #11433 from godotengine/classref/sync-0870525
classref: Sync with current master branch (0870525)
2 parents 225ba7a + 5f7832d commit 99175ce

26 files changed

+630
-114
lines changed

classes/[email protected]

Lines changed: 103 additions & 75 deletions
Large diffs are not rendered by default.

classes/class_acceptdialog.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Description
2323

2424
The default use of **AcceptDialog** is to allow it to only be accepted or closed, with the same result. However, the :ref:`confirmed<class_AcceptDialog_signal_confirmed>` and :ref:`canceled<class_AcceptDialog_signal_canceled>` signals allow to make the two actions different, and the :ref:`add_button()<class_AcceptDialog_method_add_button>` method allows to add custom buttons and actions.
2525

26+
\ **Note:** **AcceptDialog** is invisible by default. To make it visible, call one of the ``popup_*`` methods from :ref:`Window<class_Window>` on the node, such as :ref:`Window.popup_centered_clamped()<class_Window_method_popup_centered_clamped>`.
27+
2628
.. rst-class:: classref-reftable-group
2729

2830
Properties

classes/class_animationnodestatemachineplayback.rst

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,16 @@ Methods
7070
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
7171
| :ref:`float<class_float>` | :ref:`get_current_play_position<class_AnimationNodeStateMachinePlayback_method_get_current_play_position>`\ (\ ) |const| |
7272
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
73+
| :ref:`float<class_float>` | :ref:`get_fading_from_length<class_AnimationNodeStateMachinePlayback_method_get_fading_from_length>`\ (\ ) |const| |
74+
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
7375
| :ref:`StringName<class_StringName>` | :ref:`get_fading_from_node<class_AnimationNodeStateMachinePlayback_method_get_fading_from_node>`\ (\ ) |const| |
7476
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
77+
| :ref:`float<class_float>` | :ref:`get_fading_from_play_position<class_AnimationNodeStateMachinePlayback_method_get_fading_from_play_position>`\ (\ ) |const| |
78+
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
79+
| :ref:`float<class_float>` | :ref:`get_fading_length<class_AnimationNodeStateMachinePlayback_method_get_fading_length>`\ (\ ) |const| |
80+
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
81+
| :ref:`float<class_float>` | :ref:`get_fading_position<class_AnimationNodeStateMachinePlayback_method_get_fading_position>`\ (\ ) |const| |
82+
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
7583
| :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] | :ref:`get_travel_path<class_AnimationNodeStateMachinePlayback_method_get_travel_path>`\ (\ ) |const| |
7684
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
7785
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationNodeStateMachinePlayback_method_is_playing>`\ (\ ) |const| |
@@ -165,6 +173,18 @@ Returns the playback position within the current animation state.
165173

166174
----
167175

176+
.. _class_AnimationNodeStateMachinePlayback_method_get_fading_from_length:
177+
178+
.. rst-class:: classref-method
179+
180+
:ref:`float<class_float>` **get_fading_from_length**\ (\ ) |const| :ref:`🔗<class_AnimationNodeStateMachinePlayback_method_get_fading_from_length>`
181+
182+
Returns the playback state length of the node from :ref:`get_fading_from_node()<class_AnimationNodeStateMachinePlayback_method_get_fading_from_node>`. Returns ``0`` if no animation fade is occurring.
183+
184+
.. rst-class:: classref-item-separator
185+
186+
----
187+
168188
.. _class_AnimationNodeStateMachinePlayback_method_get_fading_from_node:
169189

170190
.. rst-class:: classref-method
@@ -177,6 +197,42 @@ Returns the starting state of currently fading animation.
177197

178198
----
179199

200+
.. _class_AnimationNodeStateMachinePlayback_method_get_fading_from_play_position:
201+
202+
.. rst-class:: classref-method
203+
204+
:ref:`float<class_float>` **get_fading_from_play_position**\ (\ ) |const| :ref:`🔗<class_AnimationNodeStateMachinePlayback_method_get_fading_from_play_position>`
205+
206+
Returns the playback position of the node from :ref:`get_fading_from_node()<class_AnimationNodeStateMachinePlayback_method_get_fading_from_node>`. Returns ``0`` if no animation fade is occurring.
207+
208+
.. rst-class:: classref-item-separator
209+
210+
----
211+
212+
.. _class_AnimationNodeStateMachinePlayback_method_get_fading_length:
213+
214+
.. rst-class:: classref-method
215+
216+
:ref:`float<class_float>` **get_fading_length**\ (\ ) |const| :ref:`🔗<class_AnimationNodeStateMachinePlayback_method_get_fading_length>`
217+
218+
Returns the length of the current fade animation. Returns ``0`` if no animation fade is occurring.
219+
220+
.. rst-class:: classref-item-separator
221+
222+
----
223+
224+
.. _class_AnimationNodeStateMachinePlayback_method_get_fading_position:
225+
226+
.. rst-class:: classref-method
227+
228+
:ref:`float<class_float>` **get_fading_position**\ (\ ) |const| :ref:`🔗<class_AnimationNodeStateMachinePlayback_method_get_fading_position>`
229+
230+
Returns the playback position of the current fade animation. Returns ``0`` if no animation fade is occurring.
231+
232+
.. rst-class:: classref-item-separator
233+
234+
----
235+
180236
.. _class_AnimationNodeStateMachinePlayback_method_get_travel_path:
181237

182238
.. rst-class:: classref-method

classes/class_audiostreamrandomizer.rst

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Properties
3434
+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+
3535
| :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomizer_property_random_pitch>` | ``1.0`` |
3636
+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+
37+
| :ref:`float<class_float>` | :ref:`random_pitch_semitones<class_AudioStreamRandomizer_property_random_pitch_semitones>` | ``0.0`` |
38+
+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+
3739
| :ref:`float<class_float>` | :ref:`random_volume_offset_db<class_AudioStreamRandomizer_property_random_volume_offset_db>` | ``0.0`` |
3840
+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+
3941
| :ref:`int<class_int>` | :ref:`streams_count<class_AudioStreamRandomizer_property_streams_count>` | ``0`` |
@@ -139,7 +141,28 @@ Controls how this AudioStreamRandomizer picks which AudioStream to play next.
139141
- |void| **set_random_pitch**\ (\ value\: :ref:`float<class_float>`\ )
140142
- :ref:`float<class_float>` **get_random_pitch**\ (\ )
141143

142-
The intensity of random pitch variation. A value of 1 means no variation.
144+
The largest possible frequency multiplier of the random pitch variation. A value of ``1.0`` means no variation.
145+
146+
\ **Note:** Setting this property also sets :ref:`random_pitch_semitones<class_AudioStreamRandomizer_property_random_pitch_semitones>`.
147+
148+
.. rst-class:: classref-item-separator
149+
150+
----
151+
152+
.. _class_AudioStreamRandomizer_property_random_pitch_semitones:
153+
154+
.. rst-class:: classref-property
155+
156+
:ref:`float<class_float>` **random_pitch_semitones** = ``0.0`` :ref:`🔗<class_AudioStreamRandomizer_property_random_pitch_semitones>`
157+
158+
.. rst-class:: classref-property-setget
159+
160+
- |void| **set_random_pitch_semitones**\ (\ value\: :ref:`float<class_float>`\ )
161+
- :ref:`float<class_float>` **get_random_pitch_semitones**\ (\ )
162+
163+
The largest possible distance, in semitones, of the random pitch variation. A value of ``0.0`` means no variation.
164+
165+
\ **Note:** Setting this property also sets :ref:`random_pitch<class_AudioStreamRandomizer_property_random_pitch>`.
143166

144167
.. rst-class:: classref-item-separator
145168

classes/class_confirmationdialog.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ To get cancel action, you can use:
3838

3939

4040

41+
\ **Note:** :ref:`AcceptDialog<class_AcceptDialog>` is invisible by default. To make it visible, call one of the ``popup_*`` methods from :ref:`Window<class_Window>` on the node, such as :ref:`Window.popup_centered_clamped()<class_Window_method_popup_centered_clamped>`.
42+
4143
.. rst-class:: classref-reftable-group
4244

4345
Properties

classes/class_editorfiledialog.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Description
2323

2424
Unlike :ref:`FileDialog<class_FileDialog>`, **EditorFileDialog** does not have a property for using native dialogs. Instead, native dialogs can be enabled globally via the :ref:`EditorSettings.interface/editor/use_native_file_dialogs<class_EditorSettings_property_interface/editor/use_native_file_dialogs>` editor setting. They are also enabled automatically when running in sandbox (e.g. on macOS).
2525

26+
\ **Note:** **EditorFileDialog** is invisible by default. To make it visible, call one of the ``popup_*`` methods from :ref:`Window<class_Window>` on the node, such as :ref:`Window.popup_centered_clamped()<class_Window_method_popup_centered_clamped>`.
27+
2628
.. rst-class:: classref-reftable-group
2729

2830
Properties

0 commit comments

Comments
 (0)