Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

classref: Sync with current master branch (4a01602) #9258

Merged
merged 1 commit into from
Apr 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions classes/class_acceptdialog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@ Theme Properties
.. table::
:widths: auto

+---------------------------------+---------------------------------------------------------------------------------+--------+
| :ref:`int<class_int>` | :ref:`buttons_min_height<class_AcceptDialog_theme_constant_buttons_min_height>` | ``0`` |
+---------------------------------+---------------------------------------------------------------------------------+--------+
| :ref:`int<class_int>` | :ref:`buttons_min_width<class_AcceptDialog_theme_constant_buttons_min_width>` | ``0`` |
+---------------------------------+---------------------------------------------------------------------------------+--------+
| :ref:`int<class_int>` | :ref:`buttons_separation<class_AcceptDialog_theme_constant_buttons_separation>` | ``10`` |
+---------------------------------+---------------------------------------------------------------------------------+--------+
Expand Down Expand Up @@ -320,6 +324,30 @@ Removes the ``button`` from the dialog. Does NOT free the ``button``. The ``butt
Theme Property Descriptions
---------------------------

.. _class_AcceptDialog_theme_constant_buttons_min_height:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **buttons_min_height** = ``0``

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.

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

----

.. _class_AcceptDialog_theme_constant_buttons_min_width:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **buttons_min_width** = ``0``

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.

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

----

.. _class_AcceptDialog_theme_constant_buttons_separation:

.. rst-class:: classref-themeproperty
Expand Down
8 changes: 4 additions & 4 deletions classes/class_boneattachment3d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Methods
+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_use_external_skeleton<class_BoneAttachment3D_method_get_use_external_skeleton>`\ (\ ) |const| |
+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`on_bone_pose_update<class_BoneAttachment3D_method_on_bone_pose_update>`\ (\ bone_index\: :ref:`int<class_int>`\ ) |
| |void| | :ref:`on_skeleton_update<class_BoneAttachment3D_method_on_skeleton_update>`\ (\ ) |
+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_external_skeleton<class_BoneAttachment3D_method_set_external_skeleton>`\ (\ external_skeleton\: :ref:`NodePath<class_NodePath>`\ ) |
+---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
Expand Down Expand Up @@ -151,13 +151,13 @@ Returns whether the BoneAttachment3D node is using an external :ref:`Skeleton3D<

----

.. _class_BoneAttachment3D_method_on_bone_pose_update:
.. _class_BoneAttachment3D_method_on_skeleton_update:

.. rst-class:: classref-method

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

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.
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.

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

Expand Down
4 changes: 2 additions & 2 deletions classes/class_control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Properties
+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`anchor_top<class_Control_property_anchor_top>` | ``0.0`` |
+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`auto_translate<class_Control_property_auto_translate>` | ``true`` |
| :ref:`bool<class_bool>` | :ref:`auto_translate<class_Control_property_auto_translate>` | |
+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`clip_contents<class_Control_property_clip_contents>` | ``false`` |
+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
Expand Down Expand Up @@ -1276,7 +1276,7 @@ Anchors the top edge of the node to the origin, the center or the end of its par

.. rst-class:: classref-property

:ref:`bool<class_bool>` **auto_translate** = ``true``
:ref:`bool<class_bool>` **auto_translate**

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

Expand Down
54 changes: 53 additions & 1 deletion classes/class_editorsettings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,8 @@ Properties
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`editors/3d/selection_box_color<class_EditorSettings_property_editors/3d/selection_box_color>` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`editors/3d_gizmos/gizmo_colors/aabb<class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/aabb>` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`editors/3d_gizmos/gizmo_colors/instantiated<class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/instantiated>` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`editors/3d_gizmos/gizmo_colors/joint<class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/joint>` |
Expand Down Expand Up @@ -337,6 +339,8 @@ Properties
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`interface/editor/font_subpixel_positioning<class_EditorSettings_property_interface/editor/font_subpixel_positioning>` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`interface/editor/import_resources_when_unfocused<class_EditorSettings_property_interface/editor/import_resources_when_unfocused>` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`interface/editor/localize_settings<class_EditorSettings_property_interface/editor/localize_settings>` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`interface/editor/low_processor_mode_sleep_usec<class_EditorSettings_property_interface/editor/low_processor_mode_sleep_usec>` |
Expand Down Expand Up @@ -457,6 +461,8 @@ Properties
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`interface/touchscreen/scale_gizmo_handles<class_EditorSettings_property_interface/touchscreen/scale_gizmo_handles>` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`network/connection/engine_version_update_mode<class_EditorSettings_property_network/connection/engine_version_update_mode>` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`network/connection/network_mode<class_EditorSettings_property_network/connection/network_mode>` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`network/debug/remote_host<class_EditorSettings_property_network/debug/remote_host>` |
Expand Down Expand Up @@ -1531,6 +1537,18 @@ The color to use for the selection box that surrounds selected nodes in the 3D e

----

.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/aabb:

.. rst-class:: classref-property

:ref:`Color<class_Color>` **editors/3d_gizmos/gizmo_colors/aabb**

The color to use for the AABB gizmo that displays the :ref:`GeometryInstance3D<class_GeometryInstance3D>`'s custom :ref:`AABB<class_AABB>`.

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

----

.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/instantiated:

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

----

.. _class_EditorSettings_property_interface/editor/import_resources_when_unfocused:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **interface/editor/import_resources_when_unfocused**

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.

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

----

.. _class_EditorSettings_property_interface/editor/localize_settings:

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

----

.. _class_EditorSettings_property_network/connection/engine_version_update_mode:

.. rst-class:: classref-property

:ref:`int<class_int>` **network/connection/engine_version_update_mode**

Specifies how the engine should check for updates.

- **Disable Update Checks** will block the engine from checking updates (see also :ref:`network/connection/network_mode<class_EditorSettings_property_network/connection/network_mode>`).

- **Check Newest Preview** (default for preview versions) will check for the newest available development snapshot.

- **Check Newest Stable** (default for stable versions) will check for the newest available stable version.

- **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``.

All update modes will ignore builds with different major versions (e.g. Godot 4 -> Godot 5).

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

----

.. _class_EditorSettings_property_network/connection/network_mode:

.. rst-class:: classref-property

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

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.
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.

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

Expand Down
2 changes: 1 addition & 1 deletion classes/class_fileaccess.rst
Original file line number Diff line number Diff line change
Expand Up @@ -714,7 +714,7 @@ Returns the size of the file in bytes.

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

Returns the next line of the file as a :ref:`String<class_String>`.
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.

Text is interpreted as being UTF-8 encoded.

Expand Down
12 changes: 12 additions & 0 deletions classes/class_filesystemdock.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,18 @@ Emitted when a file is moved from ``old_file`` path to ``new_file`` path.

----

.. _class_FileSystemDock_signal_folder_color_changed:

.. rst-class:: classref-signal

**folder_color_changed**\ (\ )

Emitted when folders change color.

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

----

.. _class_FileSystemDock_signal_folder_moved:

.. rst-class:: classref-signal
Expand Down
Loading