Skip to content

Commit a4b6919

Browse files
author
Godot Organization
committed
classref: Sync with current master branch (4a01602)
1 parent e585811 commit a4b6919

29 files changed

+491
-150
lines changed

classes/class_acceptdialog.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,10 @@ Theme Properties
8585
.. table::
8686
:widths: auto
8787

88+
+---------------------------------+---------------------------------------------------------------------------------+--------+
89+
| :ref:`int<class_int>` | :ref:`buttons_min_height<class_AcceptDialog_theme_constant_buttons_min_height>` | ``0`` |
90+
+---------------------------------+---------------------------------------------------------------------------------+--------+
91+
| :ref:`int<class_int>` | :ref:`buttons_min_width<class_AcceptDialog_theme_constant_buttons_min_width>` | ``0`` |
8892
+---------------------------------+---------------------------------------------------------------------------------+--------+
8993
| :ref:`int<class_int>` | :ref:`buttons_separation<class_AcceptDialog_theme_constant_buttons_separation>` | ``10`` |
9094
+---------------------------------+---------------------------------------------------------------------------------+--------+
@@ -320,6 +324,30 @@ Removes the ``button`` from the dialog. Does NOT free the ``button``. The ``butt
320324
Theme Property Descriptions
321325
---------------------------
322326

327+
.. _class_AcceptDialog_theme_constant_buttons_min_height:
328+
329+
.. rst-class:: classref-themeproperty
330+
331+
:ref:`int<class_int>` **buttons_min_height** = ``0``
332+
333+
The minimum height of each button in the bottom row (such as OK/Cancel) in pixels. This can be increased to make buttons with short texts easier to click/tap.
334+
335+
.. rst-class:: classref-item-separator
336+
337+
----
338+
339+
.. _class_AcceptDialog_theme_constant_buttons_min_width:
340+
341+
.. rst-class:: classref-themeproperty
342+
343+
:ref:`int<class_int>` **buttons_min_width** = ``0``
344+
345+
The minimum width of each button in the bottom row (such as OK/Cancel) in pixels. This can be increased to make buttons with short texts easier to click/tap.
346+
347+
.. rst-class:: classref-item-separator
348+
349+
----
350+
323351
.. _class_AcceptDialog_theme_constant_buttons_separation:
324352

325353
.. rst-class:: classref-themeproperty

classes/class_boneattachment3d.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Methods
5353
+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
5454
| :ref:`bool<class_bool>` | :ref:`get_use_external_skeleton<class_BoneAttachment3D_method_get_use_external_skeleton>`\ (\ ) |const| |
5555
+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
56-
| |void| | :ref:`on_bone_pose_update<class_BoneAttachment3D_method_on_bone_pose_update>`\ (\ bone_index\: :ref:`int<class_int>`\ ) |
56+
| |void| | :ref:`on_skeleton_update<class_BoneAttachment3D_method_on_skeleton_update>`\ (\ ) |
5757
+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
5858
| |void| | :ref:`set_external_skeleton<class_BoneAttachment3D_method_set_external_skeleton>`\ (\ external_skeleton\: :ref:`NodePath<class_NodePath>`\ ) |
5959
+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -151,13 +151,13 @@ Returns whether the BoneAttachment3D node is using an external :ref:`Skeleton3D<
151151

152152
----
153153

154-
.. _class_BoneAttachment3D_method_on_bone_pose_update:
154+
.. _class_BoneAttachment3D_method_on_skeleton_update:
155155

156156
.. rst-class:: classref-method
157157

158-
|void| **on_bone_pose_update**\ (\ bone_index\: :ref:`int<class_int>`\ )
158+
|void| **on_skeleton_update**\ (\ )
159159

160-
A function that is called automatically when the :ref:`Skeleton3D<class_Skeleton3D>` the BoneAttachment3D node is using has a bone that has changed its pose. This function is where the BoneAttachment3D node updates its position so it is correctly bound when it is *not* set to override the bone pose.
160+
A function that is called automatically when the :ref:`Skeleton3D<class_Skeleton3D>` is updated. This function is where the **BoneAttachment3D** node updates its position so it is correctly bound when it is *not* set to override the bone pose.
161161

162162
.. rst-class:: classref-item-separator
163163

classes/class_control.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Properties
7373
+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
7474
| :ref:`float<class_float>` | :ref:`anchor_top<class_Control_property_anchor_top>` | ``0.0`` |
7575
+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
76-
| :ref:`bool<class_bool>` | :ref:`auto_translate<class_Control_property_auto_translate>` | ``true`` |
76+
| :ref:`bool<class_bool>` | :ref:`auto_translate<class_Control_property_auto_translate>` | |
7777
+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
7878
| :ref:`bool<class_bool>` | :ref:`clip_contents<class_Control_property_clip_contents>` | ``false`` |
7979
+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
@@ -1276,7 +1276,7 @@ Anchors the top edge of the node to the origin, the center or the end of its par
12761276

12771277
.. rst-class:: classref-property
12781278

1279-
:ref:`bool<class_bool>` **auto_translate** = ``true``
1279+
:ref:`bool<class_bool>` **auto_translate**
12801280

12811281
.. rst-class:: classref-property-setget
12821282

classes/class_editorsettings.rst

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,8 @@ Properties
179179
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
180180
| :ref:`Color<class_Color>` | :ref:`editors/3d/selection_box_color<class_EditorSettings_property_editors/3d/selection_box_color>` |
181181
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
182+
| :ref:`Color<class_Color>` | :ref:`editors/3d_gizmos/gizmo_colors/aabb<class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/aabb>` |
183+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
182184
| :ref:`Color<class_Color>` | :ref:`editors/3d_gizmos/gizmo_colors/instantiated<class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/instantiated>` |
183185
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
184186
| :ref:`Color<class_Color>` | :ref:`editors/3d_gizmos/gizmo_colors/joint<class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/joint>` |
@@ -337,6 +339,8 @@ Properties
337339
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
338340
| :ref:`int<class_int>` | :ref:`interface/editor/font_subpixel_positioning<class_EditorSettings_property_interface/editor/font_subpixel_positioning>` |
339341
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
342+
| :ref:`bool<class_bool>` | :ref:`interface/editor/import_resources_when_unfocused<class_EditorSettings_property_interface/editor/import_resources_when_unfocused>` |
343+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
340344
| :ref:`bool<class_bool>` | :ref:`interface/editor/localize_settings<class_EditorSettings_property_interface/editor/localize_settings>` |
341345
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
342346
| :ref:`int<class_int>` | :ref:`interface/editor/low_processor_mode_sleep_usec<class_EditorSettings_property_interface/editor/low_processor_mode_sleep_usec>` |
@@ -457,6 +461,8 @@ Properties
457461
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
458462
| :ref:`float<class_float>` | :ref:`interface/touchscreen/scale_gizmo_handles<class_EditorSettings_property_interface/touchscreen/scale_gizmo_handles>` |
459463
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
464+
| :ref:`int<class_int>` | :ref:`network/connection/engine_version_update_mode<class_EditorSettings_property_network/connection/engine_version_update_mode>` |
465+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
460466
| :ref:`int<class_int>` | :ref:`network/connection/network_mode<class_EditorSettings_property_network/connection/network_mode>` |
461467
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
462468
| :ref:`String<class_String>` | :ref:`network/debug/remote_host<class_EditorSettings_property_network/debug/remote_host>` |
@@ -1531,6 +1537,18 @@ The color to use for the selection box that surrounds selected nodes in the 3D e
15311537

15321538
----
15331539

1540+
.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/aabb:
1541+
1542+
.. rst-class:: classref-property
1543+
1544+
:ref:`Color<class_Color>` **editors/3d_gizmos/gizmo_colors/aabb**
1545+
1546+
The color to use for the AABB gizmo that displays the :ref:`GeometryInstance3D<class_GeometryInstance3D>`'s custom :ref:`AABB<class_AABB>`.
1547+
1548+
.. rst-class:: classref-item-separator
1549+
1550+
----
1551+
15341552
.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/instantiated:
15351553

15361554
.. rst-class:: classref-property
@@ -2549,6 +2567,18 @@ The subpixel positioning mode to use when rendering editor font glyphs. This aff
25492567

25502568
----
25512569

2570+
.. _class_EditorSettings_property_interface/editor/import_resources_when_unfocused:
2571+
2572+
.. rst-class:: classref-property
2573+
2574+
:ref:`bool<class_bool>` **interface/editor/import_resources_when_unfocused**
2575+
2576+
If ``true``, (re)imports resources even if the editor window is unfocused or minimized. If ``false``, resources are only (re)imported when the editor window is focused. This can be set to ``true`` to speed up iteration by starting the import process earlier when saving files in the project folder. This also allows getting visual feedback on changes without having to click the editor window, which is useful with multi-monitor setups. The downside of setting this to ``true`` is that it increases idle CPU usage and may steal CPU time from other applications when importing resources.
2577+
2578+
.. rst-class:: classref-item-separator
2579+
2580+
----
2581+
25522582
.. _class_EditorSettings_property_interface/editor/localize_settings:
25532583

25542584
.. rst-class:: classref-property
@@ -3331,13 +3361,35 @@ Specify the multiplier to apply to the scale for the editor gizmo handles to imp
33313361

33323362
----
33333363

3364+
.. _class_EditorSettings_property_network/connection/engine_version_update_mode:
3365+
3366+
.. rst-class:: classref-property
3367+
3368+
:ref:`int<class_int>` **network/connection/engine_version_update_mode**
3369+
3370+
Specifies how the engine should check for updates.
3371+
3372+
- **Disable Update Checks** will block the engine from checking updates (see also :ref:`network/connection/network_mode<class_EditorSettings_property_network/connection/network_mode>`).
3373+
3374+
- **Check Newest Preview** (default for preview versions) will check for the newest available development snapshot.
3375+
3376+
- **Check Newest Stable** (default for stable versions) will check for the newest available stable version.
3377+
3378+
- **Check Newest Patch** will check for the latest available stable version, but only within the same minor version. E.g. if your version is ``4.3.stable``, you will be notified about ``4.3.1.stable``, but not ``4.4.stable``.
3379+
3380+
All update modes will ignore builds with different major versions (e.g. Godot 4 -> Godot 5).
3381+
3382+
.. rst-class:: classref-item-separator
3383+
3384+
----
3385+
33343386
.. _class_EditorSettings_property_network/connection/network_mode:
33353387

33363388
.. rst-class:: classref-property
33373389

33383390
:ref:`int<class_int>` **network/connection/network_mode**
33393391

3340-
Determines whether online features are enabled in the editor, such as the Asset Library. Setting this property to "Offline" is recommended to limit editor's internet activity, especially if privacy is a concern.
3392+
Determines whether online features are enabled in the editor, such as the Asset Library or update checks. Disabling these online features helps alleviate privacy concerns by preventing the editor from making HTTP requests to the Godot website, GitHub, or third-party platforms hosting assets from the Asset Library.
33413393

33423394
.. rst-class:: classref-item-separator
33433395

classes/class_fileaccess.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -714,7 +714,7 @@ Returns the size of the file in bytes.
714714

715715
:ref:`String<class_String>` **get_line**\ (\ ) |const|
716716

717-
Returns the next line of the file as a :ref:`String<class_String>`.
717+
Returns the next line of the file as a :ref:`String<class_String>`. The returned string doesn't include newline (``\n``) or carriage return (``\r``) characters, but does include any other leading or trailing whitespace.
718718

719719
Text is interpreted as being UTF-8 encoded.
720720

classes/class_filesystemdock.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,18 @@ Emitted when a file is moved from ``old_file`` path to ``new_file`` path.
8484

8585
----
8686

87+
.. _class_FileSystemDock_signal_folder_color_changed:
88+
89+
.. rst-class:: classref-signal
90+
91+
**folder_color_changed**\ (\ )
92+
93+
Emitted when folders change color.
94+
95+
.. rst-class:: classref-item-separator
96+
97+
----
98+
8799
.. _class_FileSystemDock_signal_folder_moved:
88100

89101
.. rst-class:: classref-signal

0 commit comments

Comments
 (0)