Skip to content

Commit fd1c631

Browse files
author
Godot Organization
committed
classref: Sync with current master branch (215acd5)
1 parent 8c18714 commit fd1c631

File tree

157 files changed

+10676
-2867
lines changed

Some content is hidden

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

157 files changed

+10676
-2867
lines changed

classes/[email protected]

+2-2
Original file line numberDiff line numberDiff line change
@@ -1089,7 +1089,7 @@ Starting from ``_ready()``, ``bar()`` would print:
10891089

10901090
**Deprecated:** Consider using :ref:`JSON.from_native()<class_JSON_method_from_native>` or :ref:`Object.get_property_list()<class_Object_method_get_property_list>` instead.
10911091

1092-
Returns the passed ``instance`` converted to a Dictionary. Can be useful for serializing.
1092+
Returns the passed ``instance`` converted to a :ref:`Dictionary<class_Dictionary>`. Can be useful for serializing.
10931093

10941094
::
10951095

@@ -1128,7 +1128,7 @@ Returns ``true`` if ``value`` is an instance of ``type``. The ``type`` value mus
11281128

11291129
- A :ref:`Script<class_Script>` (you can use any class, including inner one).
11301130

1131-
Unlike the right operand of the ``is`` operator, ``type`` can be a non-constant value. The ``is`` operator supports more features (such as typed arrays). Use the operator instead of this method if you do not need dynamic type checking.
1131+
Unlike the right operand of the ``is`` operator, ``type`` can be a non-constant value. The ``is`` operator supports more features (such as typed arrays). Use the operator instead of this method if you do not need to check the type dynamically.
11321132

11331133
\ **Examples:**\
11341134

classes/[email protected]

+1-1
Original file line numberDiff line numberDiff line change
@@ -3810,7 +3810,7 @@ Hints that a property is an :ref:`Array<class_Array>` with the stored type speci
38103810

38113811
:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_DICTIONARY_TYPE** = ``38``
38123812

3813-
Hints that a property is a :ref:`Dictionary<class_Dictionary>` with the stored types specified in the hint string.
3813+
Hints that a property is a :ref:`Dictionary<class_Dictionary>` with the stored types specified in the hint string. The hint string contains the key and value types separated by a semicolon (e.g. ``"int;String"``).
38143814

38153815
.. _class_@GlobalScope_constant_PROPERTY_HINT_LOCALE_ID:
38163816

classes/class_acceptdialog.rst

+7-3
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,11 @@ Properties
4444
+-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+
4545
| :ref:`bool<class_bool>` | keep_title_visible | ``true`` (overrides :ref:`Window<class_Window_property_keep_title_visible>`) |
4646
+-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+
47-
| :ref:`String<class_String>` | :ref:`ok_button_text<class_AcceptDialog_property_ok_button_text>` | ``"OK"`` |
47+
| :ref:`bool<class_bool>` | maximize_disabled | ``true`` (overrides :ref:`Window<class_Window_property_maximize_disabled>`) |
48+
+-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+
49+
| :ref:`bool<class_bool>` | minimize_disabled | ``true`` (overrides :ref:`Window<class_Window_property_minimize_disabled>`) |
50+
+-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+
51+
| :ref:`String<class_String>` | :ref:`ok_button_text<class_AcceptDialog_property_ok_button_text>` | ``""`` |
4852
+-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+
4953
| :ref:`String<class_String>` | title | ``"Alert!"`` (overrides :ref:`Window<class_Window_property_title>`) |
5054
+-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+
@@ -219,14 +223,14 @@ The text displayed by the dialog.
219223

220224
.. rst-class:: classref-property
221225

222-
:ref:`String<class_String>` **ok_button_text** = ``"OK"`` :ref:`🔗<class_AcceptDialog_property_ok_button_text>`
226+
:ref:`String<class_String>` **ok_button_text** = ``""`` :ref:`🔗<class_AcceptDialog_property_ok_button_text>`
223227

224228
.. rst-class:: classref-property-setget
225229

226230
- |void| **set_ok_button_text**\ (\ value\: :ref:`String<class_String>`\ )
227231
- :ref:`String<class_String>` **get_ok_button_text**\ (\ )
228232

229-
The text displayed by the OK button (see :ref:`get_ok_button()<class_AcceptDialog_method_get_ok_button>`).
233+
The text displayed by the OK button (see :ref:`get_ok_button()<class_AcceptDialog_method_get_ok_button>`). If empty, a default text will be used.
230234

231235
.. rst-class:: classref-section-separator
232236

classes/class_animatedsprite2d.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ This method is a shorthand for :ref:`play()<class_AnimatedSprite2D_method_play>`
413413

414414
|void| **set_frame_and_progress**\ (\ frame\: :ref:`int<class_int>`, progress\: :ref:`float<class_float>`\ ) :ref:`🔗<class_AnimatedSprite2D_method_set_frame_and_progress>`
415415

416-
Sets :ref:`frame<class_AnimatedSprite2D_property_frame>` the :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>` to the given values. Unlike setting :ref:`frame<class_AnimatedSprite2D_property_frame>`, this method does not reset the :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>` to ``0.0`` implicitly.
416+
Sets :ref:`frame<class_AnimatedSprite2D_property_frame>` and :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>` to the given values. Unlike setting :ref:`frame<class_AnimatedSprite2D_property_frame>`, this method does not reset the :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>` to ``0.0`` implicitly.
417417

418418
\ **Example:** Change the animation while keeping the same :ref:`frame<class_AnimatedSprite2D_property_frame>` and :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>`:
419419

classes/class_animatedsprite3d.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,7 @@ This method is a shorthand for :ref:`play()<class_AnimatedSprite3D_method_play>`
333333

334334
|void| **set_frame_and_progress**\ (\ frame\: :ref:`int<class_int>`, progress\: :ref:`float<class_float>`\ ) :ref:`🔗<class_AnimatedSprite3D_method_set_frame_and_progress>`
335335

336-
Sets :ref:`frame<class_AnimatedSprite3D_property_frame>` the :ref:`frame_progress<class_AnimatedSprite3D_property_frame_progress>` to the given values. Unlike setting :ref:`frame<class_AnimatedSprite3D_property_frame>`, this method does not reset the :ref:`frame_progress<class_AnimatedSprite3D_property_frame_progress>` to ``0.0`` implicitly.
336+
Sets :ref:`frame<class_AnimatedSprite3D_property_frame>` and :ref:`frame_progress<class_AnimatedSprite3D_property_frame_progress>` to the given values. Unlike setting :ref:`frame<class_AnimatedSprite3D_property_frame>`, this method does not reset the :ref:`frame_progress<class_AnimatedSprite3D_property_frame_progress>` to ``0.0`` implicitly.
337337

338338
\ **Example:** Change the animation while keeping the same :ref:`frame<class_AnimatedSprite3D_property_frame>` and :ref:`frame_progress<class_AnimatedSprite3D_property_frame_progress>`:
339339

classes/class_animationmixer.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -732,7 +732,7 @@ By using this in combination with :ref:`get_root_motion_rotation_accumulator()<c
732732

733733

734734

735-
If :ref:`root_motion_local<class_AnimationMixer_property_root_motion_local>` is ``true``, return the pre-multiplied translation value with the inverted rotation.
735+
If :ref:`root_motion_local<class_AnimationMixer_property_root_motion_local>` is ``true``, returns the pre-multiplied translation value with the inverted rotation.
736736

737737
In this case, the code can be written as follows:
738738

classes/class_animationplayer.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -622,7 +622,7 @@ Returns the start time of the section currently being played.
622622

623623
:ref:`bool<class_bool>` **has_section**\ (\ ) |const| :ref:`🔗<class_AnimationPlayer_method_has_section>`
624624

625-
Returns ``true`` if an animation is currently playing with section.
625+
Returns ``true`` if an animation is currently playing with a section.
626626

627627
.. rst-class:: classref-item-separator
628628

@@ -787,7 +787,7 @@ Queues an animation for playback once the current animation and all previously q
787787

788788
|void| **reset_section**\ (\ ) :ref:`🔗<class_AnimationPlayer_method_reset_section>`
789789

790-
Resets the current section if section is set.
790+
Resets the current section. Does nothing if a section has not been set.
791791

792792
.. rst-class:: classref-item-separator
793793

classes/class_array.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -916,7 +916,7 @@ Returns a hashed 32-bit integer value representing the array and its contents.
916916

917917
:ref:`int<class_int>` **insert**\ (\ position\: :ref:`int<class_int>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_Array_method_insert>`
918918

919-
Inserts a new element (``value``) at a given index (``position``) in the array. ``position`` should be between ``0`` and the array's :ref:`size()<class_Array_method_size>`.
919+
Inserts a new element (``value``) at a given index (``position``) in the array. ``position`` should be between ``0`` and the array's :ref:`size()<class_Array_method_size>`. If negative, ``position`` is considered relative to the end of the array.
920920

921921
Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` on success, or one of the other :ref:`Error<enum_@GlobalScope_Error>` constants if this method fails.
922922

@@ -1205,7 +1205,7 @@ See also :ref:`map()<class_Array_method_map>`, :ref:`filter()<class_Array_method
12051205

12061206
|void| **remove_at**\ (\ position\: :ref:`int<class_int>`\ ) :ref:`🔗<class_Array_method_remove_at>`
12071207

1208-
Removes the element from the array at the given index (``position``). If the index is out of bounds, this method fails.
1208+
Removes the element from the array at the given index (``position``). If the index is out of bounds, this method fails. If the index is negative, ``position`` is considered relative to the end of the array.
12091209

12101210
If you need to return the removed element, use :ref:`pop_at()<class_Array_method_pop_at>`. To remove an element by value, use :ref:`erase()<class_Array_method_erase>` instead.
12111211

@@ -1225,7 +1225,7 @@ If you need to return the removed element, use :ref:`pop_at()<class_Array_method
12251225

12261226
Sets the array's number of elements to ``size``. If ``size`` is smaller than the array's current size, the elements at the end are removed. If ``size`` is greater, new default elements (usually ``null``) are added, depending on the array's type.
12271227

1228-
Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` on success, or one of the other :ref:`Error<enum_@GlobalScope_Error>` constants if this method fails.
1228+
Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` on success, or one of the following :ref:`Error<enum_@GlobalScope_Error>` constants if this method fails: :ref:`@GlobalScope.ERR_LOCKED<class_@GlobalScope_constant_ERR_LOCKED>` if the array is read-only, :ref:`@GlobalScope.ERR_INVALID_PARAMETER<class_@GlobalScope_constant_ERR_INVALID_PARAMETER>` if the size is negative, or :ref:`@GlobalScope.ERR_OUT_OF_MEMORY<class_@GlobalScope_constant_ERR_OUT_OF_MEMORY>` if allocations fail. Use :ref:`size()<class_Array_method_size>` to find the actual size of the array after resize.
12291229

12301230
\ **Note:** Calling this method once and assigning the new values is faster than calling :ref:`append()<class_Array_method_append>` for every new element.
12311231

classes/class_audioeffectphaser.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Property Descriptions
7070
- |void| **set_depth**\ (\ value\: :ref:`float<class_float>`\ )
7171
- :ref:`float<class_float>` **get_depth**\ (\ )
7272

73-
Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4.
73+
Determines how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from ``0.1`` to ``4.0``.
7474

7575
.. rst-class:: classref-item-separator
7676

classes/class_audiostreamplayer3d.rst

+5-1
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,11 @@ The maximum number of sounds this node can play at the same time. Playing additi
454454
- |void| **set_panning_strength**\ (\ value\: :ref:`float<class_float>`\ )
455455
- :ref:`float<class_float>` **get_panning_strength**\ (\ )
456456

457-
Scales the panning strength for this node by multiplying the base :ref:`ProjectSettings.audio/general/3d_panning_strength<class_ProjectSettings_property_audio/general/3d_panning_strength>` with this factor. Higher values will pan audio from left to right more dramatically than lower values.
457+
Scales the panning strength for this node by multiplying the base :ref:`ProjectSettings.audio/general/3d_panning_strength<class_ProjectSettings_property_audio/general/3d_panning_strength>` by this factor. If the product is ``0.0`` then stereo panning is disabled and the volume is the same for all channels. If the product is ``1.0`` then one of the channels will be muted when the sound is located exactly to the left (or right) of the listener.
458+
459+
Two speaker stereo arrangements implement the `WebAudio standard for StereoPannerNode Panning <https://webaudio.github.io/web-audio-api/#stereopanner-algorithm>`__ where the volume is cosine of half the azimuth angle to the ear.
460+
461+
For other speaker arrangements such as the 5.1 and 7.1 the SPCAP (Speaker-Placement Correction Amplitude) algorithm is implemented.
458462

459463
.. rst-class:: classref-item-separator
460464

classes/class_basematerial3d.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -2219,7 +2219,7 @@ Texture that specifies how much surface emits light at a given point.
22192219
- |void| **set_flag**\ (\ flag\: :ref:`Flags<enum_BaseMaterial3D_Flags>`, enable\: :ref:`bool<class_bool>`\ )
22202220
- :ref:`bool<class_bool>` **get_flag**\ (\ flag\: :ref:`Flags<enum_BaseMaterial3D_Flags>`\ ) |const|
22212221

2222-
If ``true``, the object is rendered at the same size regardless of distance.
2222+
If ``true``, the object is rendered at the same size regardless of distance. The object's size on screen is the same as if the camera was ``1.0`` units away from the object's origin, regardless of the actual distance from the camera. The :ref:`Camera3D<class_Camera3D>`'s field of view (or :ref:`Camera3D.size<class_Camera3D_property_size>` when in orthogonal/frustum mode) still affects the size the object is drawn at.
22232223

22242224
.. rst-class:: classref-item-separator
22252225

classes/class_boneattachment3d.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Returns the :ref:`NodePath<class_NodePath>` to the external :ref:`Skeleton3D<cla
147147

148148
:ref:`Skeleton3D<class_Skeleton3D>` **get_skeleton**\ (\ ) :ref:`🔗<class_BoneAttachment3D_method_get_skeleton>`
149149

150-
Get parent or external :ref:`Skeleton3D<class_Skeleton3D>` node if found.
150+
Returns the parent or external :ref:`Skeleton3D<class_Skeleton3D>` node if it exists, otherwise returns ``null``.
151151

152152
.. rst-class:: classref-item-separator
153153

classes/class_button.rst

+19
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ Properties
8282
+-------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+
8383
| :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` | :ref:`autowrap_mode<class_Button_property_autowrap_mode>` | ``0`` |
8484
+-------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+
85+
| |bitfield|\[:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\] | :ref:`autowrap_trim_flags<class_Button_property_autowrap_trim_flags>` | ``128`` |
86+
+-------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+
8587
| :ref:`bool<class_bool>` | :ref:`clip_text<class_Button_property_clip_text>` | ``false`` |
8688
+-------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+
8789
| :ref:`bool<class_bool>` | :ref:`expand_icon<class_Button_property_expand_icon>` | ``false`` |
@@ -220,6 +222,23 @@ If set to something other than :ref:`TextServer.AUTOWRAP_OFF<class_TextServer_co
220222

221223
----
222224

225+
.. _class_Button_property_autowrap_trim_flags:
226+
227+
.. rst-class:: classref-property
228+
229+
|bitfield|\[:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\] **autowrap_trim_flags** = ``128`` :ref:`🔗<class_Button_property_autowrap_trim_flags>`
230+
231+
.. rst-class:: classref-property-setget
232+
233+
- |void| **set_autowrap_trim_flags**\ (\ value\: |bitfield|\[:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\]\ )
234+
- |bitfield|\[:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\] **get_autowrap_trim_flags**\ (\ )
235+
236+
Autowrap space trimming flags. See :ref:`TextServer.BREAK_TRIM_START_EDGE_SPACES<class_TextServer_constant_BREAK_TRIM_START_EDGE_SPACES>` and :ref:`TextServer.BREAK_TRIM_END_EDGE_SPACES<class_TextServer_constant_BREAK_TRIM_END_EDGE_SPACES>` for more info.
237+
238+
.. rst-class:: classref-item-separator
239+
240+
----
241+
223242
.. _class_Button_property_clip_text:
224243

225244
.. rst-class:: classref-property

classes/class_camera2d.rst

+19
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ Properties
7777
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
7878
| :ref:`int<class_int>` | :ref:`limit_bottom<class_Camera2D_property_limit_bottom>` | ``10000000`` |
7979
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
80+
| :ref:`bool<class_bool>` | :ref:`limit_enabled<class_Camera2D_property_limit_enabled>` | ``true`` |
81+
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
8082
| :ref:`int<class_int>` | :ref:`limit_left<class_Camera2D_property_limit_left>` | ``-10000000`` |
8183
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
8284
| :ref:`int<class_int>` | :ref:`limit_right<class_Camera2D_property_limit_right>` | ``10000000`` |
@@ -476,6 +478,23 @@ Bottom scroll limit in pixels. The camera stops moving when reaching this value,
476478

477479
----
478480

481+
.. _class_Camera2D_property_limit_enabled:
482+
483+
.. rst-class:: classref-property
484+
485+
:ref:`bool<class_bool>` **limit_enabled** = ``true`` :ref:`🔗<class_Camera2D_property_limit_enabled>`
486+
487+
.. rst-class:: classref-property-setget
488+
489+
- |void| **set_limit_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
490+
- :ref:`bool<class_bool>` **is_limit_enabled**\ (\ )
491+
492+
If ``true``, the limits will be enabled. Disabling this will allow the camera to focus anywhere, when the four ``limit_*`` properties will not work.
493+
494+
.. rst-class:: classref-item-separator
495+
496+
----
497+
479498
.. _class_Camera2D_property_limit_left:
480499

481500
.. rst-class:: classref-property

0 commit comments

Comments
 (0)