diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 2e229eca0..3e0846017 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -3477,7 +3477,7 @@ Hints that an :ref:`int` or :ref:`float` property should \ **Example:** ``"-360,360,1,or_greater,or_less"``. -Additionally, other keywords can be included: ``"exp"`` for exponential range editing, ``"radians_as_degrees"`` for editing radian angles in degrees (the range values are also in degrees), ``"degrees"`` to hint at an angle, ``"prefer_slider"`` to show the slider for integers, and ``"hide_control"`` to hide the slider or up-down arrows. +Additionally, other keywords can be included: ``"exp"`` for exponential range editing, ``"radians_as_degrees"`` for editing radian angles in degrees (the range values are also in degrees), ``"degrees"`` to hint at an angle, ``"prefer_slider"`` to show the slider for integers, ``"hide_control"`` to hide the slider or up-down arrows, and ``"suffix:px/s"`` to display a suffix indicating the value's unit (e.g. ``px/s`` for pixels per second). .. _class_@GlobalScope_constant_PROPERTY_HINT_ENUM: diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 54ab384e0..9be146eae 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -723,6 +723,8 @@ If ``true``, the parent **CanvasItem**'s :ref:`material` nodes. A :ref:`Viewport` will render a **CanvasItem** if it and all its parents share a layer with the :ref:`Viewport`'s canvas cull mask. +\ **Note:** A **CanvasItem** does not inherit its parents' visibility layers. This means that if a parent **CanvasItem** does not have all the same layers as its child, the child may not be visible even if both the parent and child have :ref:`visible` set to ``true``. For example, if a parent has layer 1 and a child has layer 2, the child will not be visible in a :ref:`Viewport` with the canvas cull mask set to layer 1 or 2 (see :ref:`Viewport.canvas_cull_mask`). To ensure that both the parent and child are visible, the parent must have both layers 1 and 2, or the child must have :ref:`top_level` set to ``true``. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index c1f651c36..f0ee59053 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -5607,7 +5607,7 @@ See also :ref:`screen_get_size()`. :ref:`float` **screen_get_refresh_rate**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` -Returns the current refresh rate of the specified screen. Returns ``-1.0`` if ``screen`` is invalid or the **DisplayServer** fails to find the refresh rate for the specified screen. +Returns the current refresh rate of the specified screen. When V-Sync is enabled, this returns the maximum framerate the project can effectively reach. Returns ``-1.0`` if ``screen`` is invalid or the **DisplayServer** fails to find the refresh rate for the specified screen. To fallback to a default refresh rate if the method fails, try: diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 3be229ea0..60ca86362 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -4936,7 +4936,7 @@ The renderer type that will be checked off by default when creating a new projec :ref:`int` **project_manager/directory_naming_convention** :ref:`🔗` -Directory naming convention for the project manager. Options are "No convention" (project name is directory name), "kebab-case" (default), "snake_case", "camelCase", "PascalCase", or "Title Case". +Directory naming convention for the project manager. Options are "No Convention" (project name is directory name), "kebab-case" (default), "snake_case", "camelCase", "PascalCase", or "Title Case". .. rst-class:: classref-item-separator diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 46d425051..b3b46c2c0 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -133,11 +133,9 @@ The maximum number of frames that can be rendered every second (FPS). A value of Limiting the FPS can be useful to reduce the host machine's power consumption, which reduces heat, noise emissions, and improves battery life. -If :ref:`ProjectSettings.display/window/vsync/vsync_mode` is **Enabled** or **Adaptive**, the setting takes precedence and the max FPS number cannot exceed the monitor's refresh rate. +If :ref:`ProjectSettings.display/window/vsync/vsync_mode` is **Enabled** or **Adaptive**, the setting takes precedence and the max FPS number cannot exceed the monitor's refresh rate. See also :ref:`DisplayServer.screen_get_refresh_rate()`. -If :ref:`ProjectSettings.display/window/vsync/vsync_mode` is **Enabled**, on monitors with variable refresh rate enabled (G-Sync/FreeSync), using an FPS limit a few frames lower than the monitor's refresh rate will `reduce input lag while avoiding tearing `__. - -See also :ref:`physics_ticks_per_second` and :ref:`ProjectSettings.application/run/max_fps`. +If :ref:`ProjectSettings.display/window/vsync/vsync_mode` is **Enabled**, on monitors with variable refresh rate enabled (G-Sync/FreeSync), using an FPS limit a few frames lower than the monitor's refresh rate will `reduce input lag while avoiding tearing `__. At higher refresh rates, the difference between the FPS limit and the monitor refresh rate should be increased to ensure frames to account for timing inaccuracies. The optimal formula for the FPS limit value in this scenario is ``r - (r * r) / 3600.0``, where ``r`` is the monitor's refresh rate. \ **Note:** The actual number of frames per second may still be below this value if the CPU or GPU cannot keep up with the project's logic and rendering. diff --git a/classes/class_foldablecontainer.rst b/classes/class_foldablecontainer.rst index e5cf63acb..1174ceb08 100644 --- a/classes/class_foldablecontainer.rst +++ b/classes/class_foldablecontainer.rst @@ -1,7 +1,7 @@ :github_url: hide .. meta:: - :keywords: expandable, collapsible, collapse + :keywords: expandable, collapsible, collapse, accordion, details .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. @@ -22,15 +22,11 @@ A container that can be expanded/collapsed. Description ----------- -A container that can be expanded/collapsed, with a title that can be filled with controls, such as buttons. +A container that can be expanded/collapsed, with a title that can be filled with controls, such as buttons. This is also called an accordion. -The title can be positioned at the top or bottom of the container. +The title can be positioned at the top or bottom of the container. The container can be expanded or collapsed by clicking the title or by pressing ``ui_accept`` when focused. Child control nodes are hidden when the container is collapsed. Ignores non-control children. -The container can be expanded or collapsed by clicking the title or by pressing ``ui_accept`` when focused. - -Child control nodes are hidden when the container is collapsed. Ignores non-control children. - -Can allow grouping with other FoldableContainers, check :ref:`foldable_group` and :ref:`FoldableGroup`. +A FoldableContainer can be grouped with other FoldableContainers so that only one of them can be opened at a time; see :ref:`foldable_group` and :ref:`FoldableGroup`. .. rst-class:: classref-reftable-group diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index c4600e5ee..f0d796a37 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -119,7 +119,7 @@ If ``true``, the key was already pressed before this event. An echo event is a r - |void| **set_key_label**\ (\ value\: :ref:`Key`\ ) - :ref:`Key` **get_key_label**\ (\ ) -Represents the localized label printed on the key in the current keyboard layout, which corresponds to one of the :ref:`Key` constants or any valid Unicode character. +Represents the localized label printed on the key in the current keyboard layout, which corresponds to one of the :ref:`Key` constants or any valid Unicode character. Key labels are meant for key prompts. For keyboard layouts with a single label on the key, it is equivalent to :ref:`keycode`. @@ -147,7 +147,7 @@ To get a human-readable representation of the **InputEventKey**, use ``OS.get_ke - |void| **set_keycode**\ (\ value\: :ref:`Key`\ ) - :ref:`Key` **get_keycode**\ (\ ) -Latin label printed on the key in the current keyboard layout, which corresponds to one of the :ref:`Key` constants. +Latin label printed on the key in the current keyboard layout, which corresponds to one of the :ref:`Key` constants. Key codes are meant for shortcuts expressed with a standard Latin keyboard, such as :kbd:`Ctrl + S` for a "Save" shortcut. To get a human-readable representation of the **InputEventKey**, use ``OS.get_keycode_string(event.keycode)`` where ``event`` is the **InputEventKey**. @@ -190,9 +190,9 @@ Represents the location of a key which has both left and right versions, such as - |void| **set_physical_keycode**\ (\ value\: :ref:`Key`\ ) - :ref:`Key` **get_physical_keycode**\ (\ ) -Represents the physical location of a key on the 101/102-key US QWERTY keyboard, which corresponds to one of the :ref:`Key` constants. +Represents the physical location of a key on the 101/102-key US QWERTY keyboard, which corresponds to one of the :ref:`Key` constants. Physical key codes meant for game input, such as WASD movement, where only the location of the keys is important. -To get a human-readable representation of the **InputEventKey**, use :ref:`OS.get_keycode_string()` in combination with :ref:`DisplayServer.keyboard_get_keycode_from_physical()`: +To get a human-readable representation of the **InputEventKey**, use :ref:`OS.get_keycode_string()` in combination with :ref:`DisplayServer.keyboard_get_keycode_from_physical()` or :ref:`DisplayServer.keyboard_get_label_from_physical()`: .. tabs:: @@ -202,7 +202,9 @@ To get a human-readable representation of the **InputEventKey**, use :ref:`OS.ge func _input(event): if event is InputEventKey: var keycode = DisplayServer.keyboard_get_keycode_from_physical(event.physical_keycode) + var label = DisplayServer.keyboard_get_label_from_physical(event.physical_keycode) print(OS.get_keycode_string(keycode)) + print(OS.get_keycode_string(label)) .. code-tab:: csharp @@ -211,7 +213,9 @@ To get a human-readable representation of the **InputEventKey**, use :ref:`OS.ge if (@event is InputEventKey inputEventKey) { var keycode = DisplayServer.KeyboardGetKeycodeFromPhysical(inputEventKey.PhysicalKeycode); + var label = DisplayServer.KeyboardGetLabelFromPhysical(inputEventKey.PhysicalKeycode); GD.Print(OS.GetKeycodeString(keycode)); + GD.Print(OS.GetKeycodeString(label)); } } @@ -249,7 +253,9 @@ If ``true``, the key's state is pressed. If ``false``, the key's state is releas - |void| **set_unicode**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_unicode**\ (\ ) -The key Unicode character code (when relevant), shifted by modifier keys. Unicode character codes for composite characters and complex scripts may not be available unless IME input mode is active. See :ref:`Window.set_ime_active()` for more information. +The key Unicode character code (when relevant), shifted by modifier keys. Unicode character codes for composite characters and complex scripts may not be available unless IME input mode is active. See :ref:`Window.set_ime_active()` for more information. Unicode character codes are meant for text input. + +\ **Note:** This property is set by the engine only for a pressed event. If the event is sent by an IME or a virtual keyboard, no corresponding key released event is sent. .. rst-class:: classref-section-separator diff --git a/classes/class_label.rst b/classes/class_label.rst index 4751ab8fe..0568d6907 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -24,6 +24,8 @@ Description A control for displaying plain text. It gives you control over the horizontal and vertical alignment and can wrap the text inside the node's bounding rectangle. It doesn't support bold, italics, or other rich text formatting. For that, use :ref:`RichTextLabel` instead. +\ **Note:** A single Label node is not designed to display huge amounts of text. To display large amounts of text in a single node, consider using :ref:`RichTextLabel` instead as it supports features like an integrated scroll bar and threading. :ref:`RichTextLabel` generally performs better when displaying large amounts of text (several pages or more). + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_nativemenu.rst b/classes/class_nativemenu.rst index 12e360ebc..947b9f2f6 100644 --- a/classes/class_nativemenu.rst +++ b/classes/class_nativemenu.rst @@ -128,6 +128,8 @@ Methods +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_system_menu_name`\ (\ menu_id\: :ref:`SystemMenus`\ ) |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_system_menu_text`\ (\ menu_id\: :ref:`SystemMenus`\ ) |const| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_feature`\ (\ feature\: :ref:`Feature`\ ) |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_menu`\ (\ rid\: :ref:`RID`\ ) |const| | @@ -194,6 +196,8 @@ Methods +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_popup_open_callback`\ (\ rid\: :ref:`RID`, callback\: :ref:`Callable`\ ) | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_system_menu_text`\ (\ menu_id\: :ref:`SystemMenus`, name\: :ref:`String`\ ) | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -847,6 +851,20 @@ Returns readable name of a special system menu. ---- +.. _class_NativeMenu_method_get_system_menu_text: + +.. rst-class:: classref-method + +:ref:`String` **get_system_menu_text**\ (\ menu_id\: :ref:`SystemMenus`\ ) |const| :ref:`🔗` + +Returns the text of the system menu item. + +\ **Note:** This method is implemented on macOS. + +.. rst-class:: classref-item-separator + +---- + .. _class_NativeMenu_method_has_feature: .. rst-class:: classref-method @@ -1325,6 +1343,20 @@ Registers callable to emit after the menu is closed. \ **Note:** This method is implemented only on macOS. +.. rst-class:: classref-item-separator + +---- + +.. _class_NativeMenu_method_set_system_menu_text: + +.. rst-class:: classref-method + +|void| **set_system_menu_text**\ (\ menu_id\: :ref:`SystemMenus`, name\: :ref:`String`\ ) :ref:`🔗` + +Sets the text of the system menu item. + +\ **Note:** This method is implemented on macOS. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_object.rst b/classes/class_object.rst index 0046a2492..8b79cbd72 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -258,6 +258,8 @@ Deferred connections trigger their :ref:`Callable`\ s on idle ti Persisting connections are stored when the object is serialized (such as when using :ref:`PackedScene.pack()`). In the editor, connections created through the Signals dock are always persisting. +\ **Note:** Connections to lambda functions (that is, when the function code is embedded in the :ref:`connect()` call) cannot be made persistent. + .. _class_Object_constant_CONNECT_ONE_SHOT: .. rst-class:: classref-enumeration-constant diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index e67856801..a7fdd6cf9 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -1731,7 +1731,7 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`rendering/renderer/rendering_method.web` | ``"gl_compatibility"`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/rendering_device/d3d12/agility_sdk_version` | ``613`` | + | :ref:`int` | :ref:`rendering/rendering_device/d3d12/agility_sdk_version` | ``618`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/rendering_device/d3d12/max_resource_descriptors` | ``65536`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -2502,9 +2502,9 @@ Maximum number of frames per second allowed. A value of ``0`` means "no limit". Limiting the FPS can be useful to reduce system power consumption, which reduces heat and noise emissions (and improves battery life on mobile devices). -If :ref:`display/window/vsync/vsync_mode` is set to ``Enabled`` or ``Adaptive``, it takes precedence and the forced FPS number cannot exceed the monitor's refresh rate. +If :ref:`display/window/vsync/vsync_mode` is set to ``Enabled`` or ``Adaptive``, it takes precedence and the forced FPS number cannot exceed the monitor's refresh rate. See also :ref:`DisplayServer.screen_get_refresh_rate()`. -If :ref:`display/window/vsync/vsync_mode` is ``Enabled``, on monitors with variable refresh rate enabled (G-Sync/FreeSync), using an FPS limit a few frames lower than the monitor's refresh rate will `reduce input lag while avoiding tearing `__. +If :ref:`display/window/vsync/vsync_mode` is ``Enabled``, on monitors with variable refresh rate enabled (G-Sync/FreeSync), using an FPS limit slightly lower than the monitor's refresh rate will `reduce input lag while avoiding tearing `__. At higher refresh rates, the difference between the FPS limit and the monitor refresh rate should be increased to ensure frames to account for timing inaccuracies. The optimal formula for the FPS limit value in this scenario is ``r - (r * r) / 3600.0``, where ``r`` is the monitor's refresh rate. If :ref:`display/window/vsync/vsync_mode` is ``Disabled``, limiting the FPS to a high value that can be consistently reached on the system can reduce input lag compared to an uncapped framerate. Since this works by ensuring the GPU load is lower than 100%, this latency reduction is only effective in GPU-bottlenecked scenarios, not CPU-bottlenecked scenarios. @@ -13006,9 +13006,9 @@ Override for :ref:`rendering/renderer/rendering_method` **rendering/rendering_device/d3d12/agility_sdk_version** = ``613`` :ref:`🔗` +:ref:`int` **rendering/rendering_device/d3d12/agility_sdk_version** = ``618`` :ref:`🔗` -Version code of the `Direct3D 12 Agility SDK `__ to use (``D3D12SDKVersion``). This must match the *minor* version that is installed next to the editor binary and in the export templates directory for the current editor version. For example, if you have ``1.613.3`` installed, you need to input ``613`` here. +Version code of the `Direct3D 12 Agility SDK `__ to use (``D3D12SDKVersion``). This must match the *minor* version that is installed next to the editor binary and in the export templates directory for the current editor version. For example, if you have ``1.618.5`` installed, you need to input ``618`` here. .. rst-class:: classref-item-separator diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index 7a603ca79..0185f4604 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -3718,6 +3718,8 @@ Draws SDFGI cascade data. This is the data structure that is used to bounce ligh Draws SDFGI probe data. This is the data structure that is used to give indirect lighting dynamic objects moving within the scene. +When in the editor, left-clicking a probe will display additional bright dots that show its occlusion information. A white dot means the light is not occluded at all at the dot's position, while a red dot means the light is fully occluded. Intermediate values are possible. + \ **Note:** Only supported when using the Forward+ rendering method. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_GI_BUFFER: diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 7c8fc144e..6561b2df1 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -32,6 +32,8 @@ It uses the many :ref:`ResourceFormatLoader` classes Tutorials --------- +- `Threaded Loading Demo `__ + - `Operating System Testing Demo `__ .. rst-class:: classref-reftable-group diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index d94eb4e57..0eda04435 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -327,6 +327,8 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_locale_right_to_left`\ (\ locale\: :ref:`String`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_locale_using_support_data`\ (\ locale\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_identifier`\ (\ string\: :ref:`String`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_letter`\ (\ unicode\: :ref:`int`\ ) |const| | @@ -3400,6 +3402,18 @@ Returns ``true`` if locale is right-to-left. ---- +.. _class_TextServer_method_is_locale_using_support_data: + +.. rst-class:: classref-method + +:ref:`bool` **is_locale_using_support_data**\ (\ locale\: :ref:`String`\ ) |const| :ref:`🔗` + +Returns ``true`` if the locale requires text server support data for line/word breaking. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_is_valid_identifier: .. rst-class:: classref-method diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index b5b2f3a71..e78e63036 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -314,6 +314,8 @@ Methods +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_locale_right_to_left`\ (\ locale\: :ref:`String`\ ) |virtual| |const| | +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_locale_using_support_data`\ (\ locale\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_valid_identifier`\ (\ string\: :ref:`String`\ ) |virtual| |const| | +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_valid_letter`\ (\ unicode\: :ref:`int`\ ) |virtual| |const| | @@ -2220,6 +2222,18 @@ Returns ``true`` if locale is right-to-left. ---- +.. _class_TextServerExtension_private_method__is_locale_using_support_data: + +.. rst-class:: classref-method + +:ref:`bool` **_is_locale_using_support_data**\ (\ locale\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` + +Returns ``true`` if the locale requires text server support data for line/word breaking. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_private_method__is_valid_identifier: .. rst-class:: classref-method diff --git a/classes/class_tilemaplayer.rst b/classes/class_tilemaplayer.rst index a818f2a4d..791163da6 100644 --- a/classes/class_tilemaplayer.rst +++ b/classes/class_tilemaplayer.rst @@ -342,7 +342,7 @@ The **TileMapLayer**'s physics quadrant size. Within a physics quadrant, cells w \ **Note:** As quadrants are created according to the map's coordinate system, the quadrant's "square shape" might not look like square in the **TileMapLayer**'s local coordinate system. -\ **Note:** This impacts the value returned by :ref:`get_coords_for_body_rid()`. +\ **Note:** This impacts the value returned by :ref:`get_coords_for_body_rid()`. Higher values will make that function less precise. To get the exact cell coordinates, you need to set :ref:`physics_quadrant_size` to ``1``, which disables physics chunking. .. rst-class:: classref-item-separator @@ -623,6 +623,8 @@ Returns the :ref:`TileData` object associated with the given cel Returns the coordinates of the physics quadrant (see :ref:`physics_quadrant_size`) for given physics body :ref:`RID`. Such an :ref:`RID` can be retrieved from :ref:`KinematicCollision2D.get_collider_rid()`, when colliding with a tile. +\ **Note:** Higher values of :ref:`physics_quadrant_size` will make this function less precise. To get the exact cell coordinates, you need to set :ref:`physics_quadrant_size` to ``1``, which disables physics chunking. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 0510ce89a..448673359 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -852,6 +852,8 @@ Does nothing if the current environment's :ref:`Environment.sdfgi_enabled` is ``false``. \ **Note:** Only supported when using the Forward+ rendering method. @@ -1295,6 +1297,8 @@ If ``true``, the viewport will process 3D audio streams. The rendering layers in which this **Viewport** renders :ref:`CanvasItem` nodes. +\ **Note:** A :ref:`CanvasItem` does not inherit its parents' visibility layers. See :ref:`CanvasItem.visibility_layer`'s description for details. + .. rst-class:: classref-item-separator ----