Merge pull request #10642 from godotengine/classref/sync-36d90c7

classref: Sync with current master branch (36d90c7)

Author: AThousandShips

classes/class_canvasitem.rst

@@ -1494,7 +1494,7 @@ Returns ``true`` if the node is present in the :ref:`SceneTree<class_SceneTree>`
 
 Visibility is checked only in parent nodes that inherit from **CanvasItem**, :ref:`CanvasLayer<class_CanvasLayer>`, and :ref:`Window<class_Window>`. If the parent is of any other type (such as :ref:`Node<class_Node>`, :ref:`AnimationPlayer<class_AnimationPlayer>`, or :ref:`Node3D<class_Node3D>`), it is assumed to be visible.
 
-\ **Note:** This method does not take :ref:`visibility_layer<class_CanvasItem_property_visibility_layer>` into account, so even if this method returns ``true`` the node might end up not being rendered.
+\ **Note:** This method does not take :ref:`visibility_layer<class_CanvasItem_property_visibility_layer>` into account, so even if this method returns ``true``, the node might end up not being rendered.
 
 .. rst-class:: classref-item-separator
 

classes/class_charfxtransform.rst

@@ -143,7 +143,9 @@ For example, the opening BBCode tag ``[example foo=hello bar=true baz=42 color=#
 - |void| **set_font**\ (\ value\: :ref:`RID<class_RID>`\ )
 - :ref:`RID<class_RID>` **get_font**\ (\ )
 
-Font resource used to render glyph.
+:ref:`TextServer<class_TextServer>` RID of the font used to render glyph, this value can be used with ``TextServer.font_*`` methods to retrieve font information.
+
+\ **Note:** Read-only. Setting this property won't affect drawing.
 
 .. rst-class:: classref-item-separator
 
@@ -160,7 +162,9 @@ Font resource used to render glyph.
 - |void| **set_glyph_count**\ (\ value\: :ref:`int<class_int>`\ )
 - :ref:`int<class_int>` **get_glyph_count**\ (\ )
 
-Number of glyphs in the grapheme cluster. This value is set in the first glyph of a cluster. Setting this property won't affect drawing.
+Number of glyphs in the grapheme cluster. This value is set in the first glyph of a cluster.
+
+\ **Note:** Read-only. Setting this property won't affect drawing.
 
 .. rst-class:: classref-item-separator
 
@@ -177,7 +181,9 @@ Number of glyphs in the grapheme cluster. This value is set in the first glyph o
 - |void| **set_glyph_flags**\ (\ value\: :ref:`int<class_int>`\ )
 - :ref:`int<class_int>` **get_glyph_flags**\ (\ )
 
-Glyph flags. See :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` for more info. Setting this property won't affect drawing.
+Glyph flags. See :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` for more info.
+
+\ **Note:** Read-only. Setting this property won't affect drawing.
 
 .. rst-class:: classref-item-separator
 
@@ -194,7 +200,7 @@ Glyph flags. See :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` for more info
 - |void| **set_glyph_index**\ (\ value\: :ref:`int<class_int>`\ )
 - :ref:`int<class_int>` **get_glyph_index**\ (\ )
 
-Font specific glyph index.
+Glyph index specific to the :ref:`font<class_CharFXTransform_property_font>`. If you want to replace this glyph, use :ref:`TextServer.font_get_glyph_index<class_TextServer_method_font_get_glyph_index>` with :ref:`font<class_CharFXTransform_property_font>` to get a new glyph index for a single character.
 
 .. rst-class:: classref-item-separator
 
@@ -228,7 +234,9 @@ The position offset the character will be drawn with (in pixels).
 - |void| **set_outline**\ (\ value\: :ref:`bool<class_bool>`\ )
 - :ref:`bool<class_bool>` **is_outline**\ (\ )
 
-If ``true``, FX transform is called for outline drawing. Setting this property won't affect drawing.
+If ``true``, FX transform is called for outline drawing.
+
+\ **Note:** Read-only. Setting this property won't affect drawing.
 
 .. rst-class:: classref-item-separator
 
@@ -245,7 +253,9 @@ If ``true``, FX transform is called for outline drawing. Setting this property w
 - |void| **set_range**\ (\ value\: :ref:`Vector2i<class_Vector2i>`\ )
 - :ref:`Vector2i<class_Vector2i>` **get_range**\ (\ )
 
-Absolute character range in the string, corresponding to the glyph. Setting this property won't affect drawing.
+Absolute character range in the string, corresponding to the glyph.
+
+\ **Note:** Read-only. Setting this property won't affect drawing.
 
 .. rst-class:: classref-item-separator
 
@@ -262,7 +272,9 @@ Absolute character range in the string, corresponding to the glyph. Setting this
 - |void| **set_relative_index**\ (\ value\: :ref:`int<class_int>`\ )
 - :ref:`int<class_int>` **get_relative_index**\ (\ )
 
-The character offset of the glyph, relative to the current :ref:`RichTextEffect<class_RichTextEffect>` custom block. Setting this property won't affect drawing.
+The character offset of the glyph, relative to the current :ref:`RichTextEffect<class_RichTextEffect>` custom block.
+
+\ **Note:** Read-only. Setting this property won't affect drawing.
 
 .. rst-class:: classref-item-separator
 

classes/class_editorexportplatformios.rst

@@ -50,8 +50,6 @@ Properties
    +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | :ref:`bool<class_bool>`                           | :ref:`application/export_project_only<class_EditorExportPlatformIOS_property_application/export_project_only>`                                                                       |
    +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-   | :ref:`bool<class_bool>`                           | :ref:`application/generate_simulator_library_if_missing<class_EditorExportPlatformIOS_property_application/generate_simulator_library_if_missing>`                                   |
-   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | :ref:`int<class_int>`                             | :ref:`application/icon_interpolation<class_EditorExportPlatformIOS_property_application/icon_interpolation>`                                                                         |
    +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | :ref:`String<class_String>`                       | :ref:`application/min_ios_version<class_EditorExportPlatformIOS_property_application/min_ios_version>`                                                                               |
@@ -639,18 +637,6 @@ If ``true``, exports iOS project files without building an XCArchive or ``.ipa``
 
 ----
 
-.. _class_EditorExportPlatformIOS_property_application/generate_simulator_library_if_missing:
-
-.. rst-class:: classref-property
-
-:ref:`bool<class_bool>` **application/generate_simulator_library_if_missing** :ref:`🔗<class_EditorExportPlatformIOS_property_application/generate_simulator_library_if_missing>`
-
-If ``true``, and ARM64 simulator library is missing from the export template, it is automatically generated from ARM64 device library.
-
-.. rst-class:: classref-item-separator
-
-----
-
 .. _class_EditorExportPlatformIOS_property_application/icon_interpolation:
 
 .. rst-class:: classref-property

classes/class_editorsettings.rst

@@ -3027,10 +3027,37 @@ Port used for file server when exporting project with remote file system.
 
 :ref:`String<class_String>` **filesystem/import/blender/blender_path** :ref:`🔗<class_EditorSettings_property_filesystem/import/blender/blender_path>`
 
-The path to the directory containing the Blender executable used for converting the Blender 3D scene files ``.blend`` to glTF 2.0 format during import. Blender 3.0 or later is required.
+The path to the Blender executable used for converting the Blender 3D scene files ``.blend`` to glTF 2.0 format during import. Blender 3.0 or later is required.
 
 To enable this feature for your specific project, use :ref:`ProjectSettings.filesystem/import/blender/enabled<class_ProjectSettings_property_filesystem/import/blender/enabled>`.
 
+If this setting is empty, Blender's default paths will be detected and used automatically if present in this order:
+
+\ **Windows:**\ 
+
+::
+
+    - C:\Program Files\Blender Foundation\blender.exe
+    - C:\Program Files (x86)\Blender Foundation\blender.exe
+
+\ **macOS:**\ 
+
+::
+
+    - /opt/homebrew/bin/blender
+    - /opt/local/bin/blender
+    - /usr/local/bin/blender
+    - /usr/local/opt/blender
+    - /Applications/Blender.app/Contents/MacOS/Blender
+
+\ **Linux/\*BSD:**\ 
+
+::
+
+    - /usr/bin/blender
+    - /usr/local/bin/blender
+    - /opt/blender/bin/blender
+
 .. rst-class:: classref-item-separator
 
 ----

classes/class_fileaccess.rst

@@ -742,7 +742,7 @@ Returns ``true``, if file ``hidden`` attribute is set.
 
 :ref:`int<class_int>` **get_length**\ (\ ) |const| :ref:`🔗<class_FileAccess_method_get_length>`
 
-Returns the size of the file in bytes.
+Returns the size of the file in bytes. For a pipe, returns the number of bytes available for reading from the pipe.
 
 .. rst-class:: classref-item-separator
 

classes/class_gpuparticlescollisionheightfield3d.rst

@@ -40,13 +40,29 @@ Properties
    +-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------+
    | :ref:`bool<class_bool>`                                               | :ref:`follow_camera_enabled<class_GPUParticlesCollisionHeightField3D_property_follow_camera_enabled>` | ``false``            |
    +-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------+
+   | :ref:`int<class_int>`                                                 | :ref:`heightfield_mask<class_GPUParticlesCollisionHeightField3D_property_heightfield_mask>`           | ``1048575``          |
+   +-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------+
    | :ref:`Resolution<enum_GPUParticlesCollisionHeightField3D_Resolution>` | :ref:`resolution<class_GPUParticlesCollisionHeightField3D_property_resolution>`                       | ``2``                |
    +-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------+
    | :ref:`Vector3<class_Vector3>`                                         | :ref:`size<class_GPUParticlesCollisionHeightField3D_property_size>`                                   | ``Vector3(2, 2, 2)`` |
    +-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------+
    | :ref:`UpdateMode<enum_GPUParticlesCollisionHeightField3D_UpdateMode>` | :ref:`update_mode<class_GPUParticlesCollisionHeightField3D_property_update_mode>`                     | ``0``                |
    +-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------+
 
+.. rst-class:: classref-reftable-group
+
+Methods
+-------
+
+.. table::
+   :widths: auto
+
+   +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | :ref:`bool<class_bool>` | :ref:`get_heightfield_mask_value<class_GPUParticlesCollisionHeightField3D_method_get_heightfield_mask_value>`\ (\ layer_number\: :ref:`int<class_int>`\ ) |const|                          |
+   +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | |void|                  | :ref:`set_heightfield_mask_value<class_GPUParticlesCollisionHeightField3D_method_set_heightfield_mask_value>`\ (\ layer_number\: :ref:`int<class_int>`, value\: :ref:`bool<class_bool>`\ ) |
+   +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
 .. rst-class:: classref-section-separator
 
 ----
@@ -172,6 +188,27 @@ Following the camera has a performance cost, as it will force the heightmap to u
 
 ----
 
+.. _class_GPUParticlesCollisionHeightField3D_property_heightfield_mask:
+
+.. rst-class:: classref-property
+
+:ref:`int<class_int>` **heightfield_mask** = ``1048575`` :ref:`🔗<class_GPUParticlesCollisionHeightField3D_property_heightfield_mask>`
+
+.. rst-class:: classref-property-setget
+
+- |void| **set_heightfield_mask**\ (\ value\: :ref:`int<class_int>`\ )
+- :ref:`int<class_int>` **get_heightfield_mask**\ (\ )
+
+The visual layers to account for when updating the heightmap. Only :ref:`MeshInstance3D<class_MeshInstance3D>`\ s whose :ref:`VisualInstance3D.layers<class_VisualInstance3D_property_layers>` match with this :ref:`heightfield_mask<class_GPUParticlesCollisionHeightField3D_property_heightfield_mask>` will be included in the heightmap collision update. By default, all 20 user-visible layers are taken into account for updating the heightmap collision.
+
+\ **Note:** Since the :ref:`heightfield_mask<class_GPUParticlesCollisionHeightField3D_property_heightfield_mask>` allows for 32 layers to be stored in total, there are an additional 12 layers that are only used internally by the engine and aren't exposed in the editor. Setting :ref:`heightfield_mask<class_GPUParticlesCollisionHeightField3D_property_heightfield_mask>` using a script allows you to toggle those reserved layers, which can be useful for editor plugins.
+
+To adjust :ref:`heightfield_mask<class_GPUParticlesCollisionHeightField3D_property_heightfield_mask>` more easily using a script, use :ref:`get_heightfield_mask_value<class_GPUParticlesCollisionHeightField3D_method_get_heightfield_mask_value>` and :ref:`set_heightfield_mask_value<class_GPUParticlesCollisionHeightField3D_method_set_heightfield_mask_value>`.
+
+.. rst-class:: classref-item-separator
+
+----
+
 .. _class_GPUParticlesCollisionHeightField3D_property_resolution:
 
 .. rst-class:: classref-property
@@ -219,6 +256,35 @@ The collision heightmap's size in 3D units. To improve heightmap quality, :ref:`
 
 The update policy to use for the generated heightmap.
 
+.. rst-class:: classref-section-separator
+
+----
+
+.. rst-class:: classref-descriptions-group
+
+Method Descriptions
+-------------------
+
+.. _class_GPUParticlesCollisionHeightField3D_method_get_heightfield_mask_value:
+
+.. rst-class:: classref-method
+
+:ref:`bool<class_bool>` **get_heightfield_mask_value**\ (\ layer_number\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_GPUParticlesCollisionHeightField3D_method_get_heightfield_mask_value>`
+
+Returns ``true`` if the specified layer of the :ref:`heightfield_mask<class_GPUParticlesCollisionHeightField3D_property_heightfield_mask>` is enabled, given a ``layer_number`` between ``1`` and ``20``, inclusive.
+
+.. rst-class:: classref-item-separator
+
+----
+
+.. _class_GPUParticlesCollisionHeightField3D_method_set_heightfield_mask_value:
+
+.. rst-class:: classref-method
+
+|void| **set_heightfield_mask_value**\ (\ layer_number\: :ref:`int<class_int>`, value\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_GPUParticlesCollisionHeightField3D_method_set_heightfield_mask_value>`
+
+Based on ``value``, enables or disables the specified layer in the :ref:`heightfield_mask<class_GPUParticlesCollisionHeightField3D_property_heightfield_mask>`, given a ``layer_number`` between ``1`` and ``20``, inclusive.
+
 .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
 .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
 .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

classes/class_javascriptbridge.rst

@@ -94,6 +94,8 @@ Method Descriptions
 
 Creates a reference to a :ref:`Callable<class_Callable>` that can be used as a callback by JavaScript. The reference must be kept until the callback happens, or it won't be called at all. See :ref:`JavaScriptObject<class_JavaScriptObject>` for usage.
 
+\ **Note:** The callback function must take exactly one :ref:`Array<class_Array>` argument, which is going to be the JavaScript `arguments object <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/arguments>`__ converted to an array.
+
 .. rst-class:: classref-item-separator
 
 ----

classes/class_node3d.rst

@@ -784,6 +784,10 @@ Returns whether the node notifies about its global and local transformation chan
 
 Returns ``true`` if the node is present in the :ref:`SceneTree<class_SceneTree>`, its :ref:`visible<class_Node3D_property_visible>` property is ``true`` and all its ancestors are also visible. If any ancestor is hidden, this node will not be visible in the scene tree.
 
+Visibility is checked only in parent nodes that inherit from **Node3D**. If the parent is of any other type (such as :ref:`Node<class_Node>`, :ref:`AnimationPlayer<class_AnimationPlayer>`, or :ref:`Node2D<class_Node2D>`), it is assumed to be visible.
+
+\ **Note:** This method does not take :ref:`VisualInstance3D.layers<class_VisualInstance3D_property_layers>` into account, so even if this method returns ``true``, the node might end up not being rendered.
+
 .. rst-class:: classref-item-separator
 
 ----

classes/class_packedstringarray.rst

@@ -440,7 +440,7 @@ Sorts the elements of the array in ascending order.
 
 :ref:`PackedByteArray<class_PackedByteArray>` **to_byte_array**\ (\ ) |const| :ref:`🔗<class_PackedStringArray_method_to_byte_array>`
 
-Returns a :ref:`PackedByteArray<class_PackedByteArray>` with each string encoded as bytes.
+Returns a :ref:`PackedByteArray<class_PackedByteArray>` with each string encoded as UTF-8. Strings are ``null`` terminated.
 
 .. rst-class:: classref-section-separator