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 (3978628) #103

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
2 changes: 1 addition & 1 deletion classes/class_array.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1256,7 +1256,7 @@ If ``deep`` is ``true``, all nested **Array** and :ref:`Dictionary<class_Diction

|void| **sort**\ (\ ) :ref:`🔗<class_Array_method_sort>`

Sorts the array in ascending order. The final order is dependent on the "less than" (``>``) comparison between elements.
Sorts the array in ascending order. The final order is dependent on the "less than" (``<``) comparison between elements.


.. tabs::
Expand Down
4 changes: 4 additions & 0 deletions classes/class_color.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1771,6 +1771,8 @@ Decodes a **Color** from an RGBE9995 format integer. See :ref:`Image.FORMAT_RGBE

Creates a **Color** from the given string, which can be either an HTML color code or a named color (case-insensitive). Returns ``default`` if the color cannot be inferred from the string.

If you want to create a color from String in a constant expression, use the equivalent constructor instead (i.e. ``Color("color string")``).

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

----
Expand Down Expand Up @@ -1816,6 +1818,8 @@ In GDScript and C#, the :ref:`int<class_int>` is best visualized with hexadecima



If you want to use hex notation in a constant expression, use the equivalent constructor instead (i.e. ``Color(0xRRGGBBAA)``).

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

----
Expand Down
4 changes: 2 additions & 2 deletions classes/class_editorsettings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4155,7 +4155,7 @@ If ``true``, allows scrolling past the end of the file.

:ref:`bool<class_bool>` **text_editor/behavior/navigation/smooth_scrolling** :ref:`🔗<class_EditorSettings_property_text_editor/behavior/navigation/smooth_scrolling>`

If ``true``, allows scrolling in sub-line intervals and enables a smooth scrolling animation when using the mouse wheel to scroll.
If ``true``, enables a smooth scrolling animation when using the mouse wheel to scroll. See :ref:`text_editor/behavior/navigation/v_scroll_speed<class_EditorSettings_property_text_editor/behavior/navigation/v_scroll_speed>` for the speed of this animation.

\ **Note:** :ref:`text_editor/behavior/navigation/smooth_scrolling<class_EditorSettings_property_text_editor/behavior/navigation/smooth_scrolling>` currently behaves poorly in projects where :ref:`ProjectSettings.physics/common/physics_ticks_per_second<class_ProjectSettings_property_physics/common/physics_ticks_per_second>` has been increased significantly from its default value (``60``). In this case, it is recommended to disable this setting.

Expand Down Expand Up @@ -4205,7 +4205,7 @@ If ``true``, uses the characters in ```!"#$%&'()*+,-./:;<=>?@[\]^`{|}~``, the Un

:ref:`int<class_int>` **text_editor/behavior/navigation/v_scroll_speed** :ref:`🔗<class_EditorSettings_property_text_editor/behavior/navigation/v_scroll_speed>`

The number of pixels to scroll with every mouse wheel increment. Higher values make the script scroll by faster when using the mouse wheel.
The speed of scrolling in lines per second when :ref:`text_editor/behavior/navigation/smooth_scrolling<class_EditorSettings_property_text_editor/behavior/navigation/smooth_scrolling>` is ``true``. Higher values make the script scroll by faster when using the mouse wheel.

\ **Note:** You can hold down :kbd:`Alt` while using the mouse wheel to temporarily scroll 5 times faster.

Expand Down
2 changes: 1 addition & 1 deletion classes/class_font.rst
Original file line number Diff line number Diff line change
Expand Up @@ -501,7 +501,7 @@ To print available variation axes of a variable font:
::

var fv = FontVariation.new()
fv.set_base_font = load("res://RobotoFlex.ttf")
fv.base_font = load("res://RobotoFlex.ttf")
var variation_list = fv.get_supported_variation_list()
for tag in variation_list:
var name = TextServerManager.get_primary_interface().tag_to_name(tag)
Expand Down
4 changes: 2 additions & 2 deletions classes/class_fontvariation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ To use simulated bold font variant:
.. code-tab:: gdscript

var fv = FontVariation.new()
fv.set_base_font(load("res://BarlowCondensed-Regular.ttf"))
fv.set_variation_embolden(1.2)
fv.base_font = load("res://BarlowCondensed-Regular.ttf")
fv.variation_embolden = 1.2
$Label.add_theme_font_override("font", fv)
$Label.add_theme_font_size_override("font_size", 64)

Expand Down
2 changes: 1 addition & 1 deletion classes/class_inputeventshortcut.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Represents a triggered keyboard :ref:`Shortcut<class_Shortcut>`.
Description
-----------

InputEventShortcut is a special event that can be received in :ref:`Node._unhandled_key_input<class_Node_private_method__unhandled_key_input>`. It is typically sent by the editor's Command Palette to trigger actions, but can also be sent manually using :ref:`Viewport.push_input<class_Viewport_method_push_input>`.
InputEventShortcut is a special event that can be received in :ref:`Node._input<class_Node_private_method__input>`, :ref:`Node._shortcut_input<class_Node_private_method__shortcut_input>`, and :ref:`Node._unhandled_input<class_Node_private_method__unhandled_input>`. It is typically sent by the editor's Command Palette to trigger actions, but can also be sent manually using :ref:`Viewport.push_input<class_Viewport_method_push_input>`.

.. rst-class:: classref-reftable-group

Expand Down
2 changes: 1 addition & 1 deletion classes/class_mobilevrinterface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ You can initialize this interface as follows:

var interface = XRServer.find_interface("Native mobile")
if interface and interface.initialize():
get_viewport().xr = true
get_viewport().use_xr = true

.. rst-class:: classref-reftable-group

Expand Down
2 changes: 2 additions & 0 deletions classes/class_os.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1057,6 +1057,8 @@ Returns the exit code of a spawned process once it has finished running (see :re

Returns ``-1`` if the ``pid`` is not a PID of a spawned child process, the process is still running, or the method is not implemented for the current platform.

\ **Note:** Returns ``-1`` if the ``pid`` is a macOS bundled app process.

\ **Note:** This method is implemented on Android, Linux, macOS and Windows.

.. rst-class:: classref-item-separator
Expand Down
32 changes: 32 additions & 0 deletions classes/class_projectsettings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1523,6 +1523,10 @@ Properties
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver.windows<class_ProjectSettings_property_rendering/rendering_device/driver.windows>` | |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`rendering/rendering_device/fallback_to_d3d12<class_ProjectSettings_property_rendering/rendering_device/fallback_to_d3d12>` | ``true`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`rendering/rendering_device/fallback_to_vulkan<class_ProjectSettings_property_rendering/rendering_device/fallback_to_vulkan>` | ``true`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`rendering/rendering_device/pipeline_cache/enable<class_ProjectSettings_property_rendering/rendering_device/pipeline_cache/enable>` | ``true`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`rendering/rendering_device/pipeline_cache/save_chunk_size_mb<class_ProjectSettings_property_rendering/rendering_device/pipeline_cache/save_chunk_size_mb>` | ``3.0`` |
Expand Down Expand Up @@ -11202,6 +11206,34 @@ Windows override for :ref:`rendering/rendering_device/driver<class_ProjectSettin

----

.. _class_ProjectSettings_property_rendering/rendering_device/fallback_to_d3d12:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **rendering/rendering_device/fallback_to_d3d12** = ``true`` :ref:`🔗<class_ProjectSettings_property_rendering/rendering_device/fallback_to_d3d12>`

If ``true``, the forward renderer will fall back to Direct3D 12 if Vulkan is not supported.

\ **Note:** This setting is implemented only on Windows.

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

----

.. _class_ProjectSettings_property_rendering/rendering_device/fallback_to_vulkan:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **rendering/rendering_device/fallback_to_vulkan** = ``true`` :ref:`🔗<class_ProjectSettings_property_rendering/rendering_device/fallback_to_vulkan>`

If ``true``, the forward renderer will fall back to Vulkan if Direct3D 12 is not supported.

\ **Note:** This setting is implemented only on Windows.

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

----

.. _class_ProjectSettings_property_rendering/rendering_device/pipeline_cache/enable:

.. rst-class:: classref-property
Expand Down