From f95c1a2b4eefd02e636047197fc166bf9c61a133 Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Sat, 25 May 2024 03:20:46 +0000 Subject: [PATCH] classref: Sync with current master branch (b7feebe) --- classes/class_@gdscript.rst | 4 +- classes/class_@globalscope.rst | 14 ----- classes/class_button.rst | 2 +- classes/class_confirmationdialog.rst | 4 +- classes/class_csharpscript.rst | 2 - classes/class_displayserver.rst | 16 ++++- classes/class_editorinspector.rst | 2 - classes/class_editorinspectorplugin.rst | 2 + classes/class_geometry2d.rst | 2 + classes/class_gltfdocument.rst | 2 + classes/class_gltfstate.rst | 19 ++++++ classes/class_godotsharp.rst | 62 ------------------- classes/class_object.rst | 2 +- .../class_openxrextensionwrapperextension.rst | 14 +++++ classes/class_tree.rst | 6 +- classes/class_treeitem.rst | 46 +++++--------- classes/index.rst | 1 - 17 files changed, 81 insertions(+), 119 deletions(-) delete mode 100644 classes/class_godotsharp.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index efd80ae5fde..f2b1e4a7cba 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -213,12 +213,14 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_COLOR_NO_ALPHA`, hint_string\: :ref:`String`, usage\: |bitfield|\[:ref:`PropertyUsageFlags`\] = 6\ ) -Allows you to set a custom hint, hint string, and usage flags for the exported property. Note that there's no validation done in GDScript, it will just pass the hint along to the editor. +Allows you to set a custom hint, hint string, and usage flags for the exported property. Note that there's no validation done in GDScript, it will just pass the parameters to the editor. :: @export_custom(PROPERTY_HINT_NONE, "suffix:m") var suffix: Vector3 +\ **Note:** Regardless of the ``usage`` value, the :ref:`@GlobalScope.PROPERTY_USAGE_SCRIPT_VARIABLE` flag is always added, as with any explicitly declared script variable. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 8426cd3bfba..f61e9d29367 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -63,8 +63,6 @@ Properties +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`Geometry3D` | :ref:`Geometry3D` | +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`GodotSharp` | :ref:`GodotSharp` | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`IP` | :ref:`IP` | +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`Input` | :ref:`Input` | @@ -4879,18 +4877,6 @@ The :ref:`Geometry3D` singleton. ---- -.. _class_@GlobalScope_property_GodotSharp: - -.. rst-class:: classref-property - -:ref:`GodotSharp` **GodotSharp** - -The :ref:`GodotSharp` singleton. - -.. rst-class:: classref-item-separator - ----- - .. _class_@GlobalScope_property_IP: .. rst-class:: classref-property diff --git a/classes/class_button.rst b/classes/class_button.rst index ea2d846fb47..3c8acce77a6 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -567,7 +567,7 @@ The horizontal space between **Button**'s icon and text. Negative values will be :ref:`int` **icon_max_width** = ``0`` -The maximum allowed width of the **Button**'s icon. This limit is applied on top of the default size of the icon, or its expanded size if :ref:`expand_icon` is ``true``. The height is adjusted according to the icon's ratio. +The maximum allowed width of the **Button**'s icon. This limit is applied on top of the default size of the icon, or its expanded size if :ref:`expand_icon` is ``true``. The height is adjusted according to the icon's ratio. If the button has additional icons (e.g. :ref:`CheckBox`), they will also be limited. .. rst-class:: classref-item-separator diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index 16e1c04761a..2024112396a 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -30,11 +30,11 @@ To get cancel action, you can use: .. code-tab:: gdscript - get_cancel_button().pressed.connect(self.canceled) + get_cancel_button().pressed.connect(_on_canceled) .. code-tab:: csharp - GetCancelButton().Pressed += Canceled; + GetCancelButton().Pressed += OnCanceled; diff --git a/classes/class_csharpscript.rst b/classes/class_csharpscript.rst index 6577e00e58d..a13903dbd90 100644 --- a/classes/class_csharpscript.rst +++ b/classes/class_csharpscript.rst @@ -21,8 +21,6 @@ Description This class represents a C# script. It is the C# equivalent of the :ref:`GDScript` class and is only available in Mono-enabled Godot builds. -See also :ref:`GodotSharp`. - .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index ab9ca0a92e1..7ff484f8d61 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -204,6 +204,8 @@ Methods +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_touchscreen_available`\ (\ ) |const| | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_window_transparency_available`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`keyboard_get_current_layout`\ (\ ) |const| | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Key` | :ref:`keyboard_get_keycode_from_physical`\ (\ keycode\: :ref:`Key`\ ) |const| | @@ -1118,7 +1120,7 @@ The window is floating on top of all other windows. This flag is ignored for ful The window background can be transparent. -\ **Note:** This flag has no effect if :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed` is set to ``false``. +\ **Note:** This flag has no effect if :ref:`is_window_transparency_available` returns ``false``. \ **Note:** Transparency support is implemented on Linux (X11/Wayland), macOS, and Windows, but availability might vary depending on GPU driver, display manager, and compositor capabilities. @@ -2969,6 +2971,18 @@ Returns ``true`` if touch events are available (Android or iOS), the capability ---- +.. _class_DisplayServer_method_is_window_transparency_available: + +.. rst-class:: classref-method + +:ref:`bool` **is_window_transparency_available**\ (\ ) |const| + +Returns ``true`` if the window background can be made transparent. This method returns ``false`` if :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed` is set to ``false``, or if transparency is not supported by the renderer or OS compositor. + +.. rst-class:: classref-item-separator + +---- + .. _class_DisplayServer_method_keyboard_get_current_layout: .. rst-class:: classref-method diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index 4e96955b726..4874857023a 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -39,8 +39,6 @@ Properties .. table:: :widths: auto - +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ - | :ref:`bool` | follow_focus | ``true`` (overrides :ref:`ScrollContainer`) | +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`ScrollMode` | horizontal_scroll_mode | ``0`` (overrides :ref:`ScrollContainer`) | +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ diff --git a/classes/class_editorinspectorplugin.rst b/classes/class_editorinspectorplugin.rst index 40a010ebb08..2ed53cf30ba 100644 --- a/classes/class_editorinspectorplugin.rst +++ b/classes/class_editorinspectorplugin.rst @@ -169,6 +169,8 @@ Adds a custom control, which is not necessarily a property editor. Adds a property editor for an individual property. The ``editor`` control must extend :ref:`EditorProperty`. +There can be multiple property editors for a property. If ``add_to_end`` is ``true``, this newly added editor will be displayed after all the other editors of the property whose ``add_to_end`` is ``false``. For example, the editor uses this parameter to add an "Edit Region" button for :ref:`Sprite2D.region_rect` below the regular :ref:`Rect2` editor. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_geometry2d.rst b/classes/class_geometry2d.rst index 9be7b9ca6ad..d9b856f01e3 100644 --- a/classes/class_geometry2d.rst +++ b/classes/class_geometry2d.rst @@ -375,6 +375,8 @@ Returns ``true`` if ``point`` is inside ``polygon`` or if it's located exactly * Returns ``true`` if ``polygon``'s vertices are ordered in clockwise order, otherwise returns ``false``. +\ **Note:** Assumes a Cartesian coordinate system where ``+x`` is right and ``+y`` is up. If using screen coordinates (``+y`` is down), the result will need to be flipped (i.e. a ``true`` result will indicate counter-clockwise). + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_gltfdocument.rst b/classes/class_gltfdocument.rst index 42251b280c4..2b76d4e1e6d 100644 --- a/classes/class_gltfdocument.rst +++ b/classes/class_gltfdocument.rst @@ -248,6 +248,8 @@ Takes a :ref:`GLTFState` object through the ``state`` parameter Takes a :ref:`GLTFState` object through the ``state`` parameter and returns a Godot Engine scene node. +The ``bake_fps`` parameter overrides the bake_fps in ``state``. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_gltfstate.rst b/classes/class_gltfstate.rst index 27093e6088b..7a719b5ed11 100644 --- a/classes/class_gltfstate.rst +++ b/classes/class_gltfstate.rst @@ -42,6 +42,8 @@ Properties .. table:: :widths: auto + +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+ + | :ref:`float` | :ref:`bake_fps` | ``30.0`` | +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+ | :ref:`String` | :ref:`base_path` | ``""`` | +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+ @@ -210,6 +212,23 @@ Embeds textures compressed losslessly into the generated scene, matching old beh Property Descriptions --------------------- +.. _class_GLTFState_property_bake_fps: + +.. rst-class:: classref-property + +:ref:`float` **bake_fps** = ``30.0`` + +.. rst-class:: classref-property-setget + +- |void| **set_bake_fps**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bake_fps**\ (\ ) + +The baking fps of the animation for either import or export. + +.. rst-class:: classref-item-separator + +---- + .. _class_GLTFState_property_base_path: .. rst-class:: classref-property diff --git a/classes/class_godotsharp.rst b/classes/class_godotsharp.rst deleted file mode 100644 index 35b23938761..00000000000 --- a/classes/class_godotsharp.rst +++ /dev/null @@ -1,62 +0,0 @@ -:github_url: hide - -.. DO NOT EDIT THIS FILE!!! -.. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/mono/doc_classes/GodotSharp.xml. - -.. _class_GodotSharp: - -GodotSharp -========== - -**Inherits:** :ref:`Object` - -Bridge between Godot and the Mono runtime (Mono-enabled builds only). - -.. rst-class:: classref-introduction-group - -Description ------------ - -This class is a bridge between Godot and the Mono runtime. It exposes several low-level operations and is only available in Mono-enabled Godot builds. - -See also :ref:`CSharpScript`. - -.. rst-class:: classref-reftable-group - -Methods -------- - -.. table:: - :widths: auto - - +-------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_runtime_initialized`\ (\ ) | - +-------------------------+-------------------------------------------------------------------------------------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Method Descriptions -------------------- - -.. _class_GodotSharp_method_is_runtime_initialized: - -.. rst-class:: classref-method - -:ref:`bool` **is_runtime_initialized**\ (\ ) - -Returns ``true`` if the .NET runtime is initialized, ``false`` otherwise. - -.. |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.)` -.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` -.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` -.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` -.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` -.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_object.rst b/classes/class_object.rst index bcafbc2760a..54ed3861ce0 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -10,7 +10,7 @@ Object ====== -**Inherited By:** :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`DisplayServer`, :ref:`EditorFileSystemDirectory`, :ref:`EditorInterface`, :ref:`EditorPaths`, :ref:`EditorSelection`, :ref:`EditorUndoRedoManager`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`EngineDebugger`, :ref:`FramebufferCacheRD`, :ref:`GDExtensionManager`, :ref:`Geometry2D`, :ref:`Geometry3D`, :ref:`GodotSharp`, :ref:`Input`, :ref:`InputMap`, :ref:`IP`, :ref:`JavaClassWrapper`, :ref:`JavaScriptBridge`, :ref:`JNISingleton`, :ref:`JSONRPC`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`MovieWriter`, :ref:`NativeMenu`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer2D`, :ref:`NavigationServer3D`, :ref:`Node`, :ref:`OpenXRExtensionWrapperExtension`, :ref:`OpenXRInteractionProfileMetadata`, :ref:`OS`, :ref:`Performance`, :ref:`PhysicsDirectBodyState2D`, :ref:`PhysicsDirectBodyState3D`, :ref:`PhysicsDirectSpaceState2D`, :ref:`PhysicsDirectSpaceState3D`, :ref:`PhysicsServer2D`, :ref:`PhysicsServer2DManager`, :ref:`PhysicsServer3D`, :ref:`PhysicsServer3DManager`, :ref:`PhysicsServer3DRenderingServerHandler`, :ref:`ProjectSettings`, :ref:`RefCounted`, :ref:`RenderData`, :ref:`RenderingDevice`, :ref:`RenderingServer`, :ref:`RenderSceneData`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`ResourceUID`, :ref:`ScriptLanguage`, :ref:`TextServerManager`, :ref:`ThemeDB`, :ref:`TileData`, :ref:`Time`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`UniformSetCacheRD`, :ref:`WorkerThreadPool`, :ref:`XRServer`, :ref:`XRVRS` +**Inherited By:** :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`DisplayServer`, :ref:`EditorFileSystemDirectory`, :ref:`EditorInterface`, :ref:`EditorPaths`, :ref:`EditorSelection`, :ref:`EditorUndoRedoManager`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`EngineDebugger`, :ref:`FramebufferCacheRD`, :ref:`GDExtensionManager`, :ref:`Geometry2D`, :ref:`Geometry3D`, :ref:`Input`, :ref:`InputMap`, :ref:`IP`, :ref:`JavaClassWrapper`, :ref:`JavaScriptBridge`, :ref:`JNISingleton`, :ref:`JSONRPC`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`MovieWriter`, :ref:`NativeMenu`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer2D`, :ref:`NavigationServer3D`, :ref:`Node`, :ref:`OpenXRExtensionWrapperExtension`, :ref:`OpenXRInteractionProfileMetadata`, :ref:`OS`, :ref:`Performance`, :ref:`PhysicsDirectBodyState2D`, :ref:`PhysicsDirectBodyState3D`, :ref:`PhysicsDirectSpaceState2D`, :ref:`PhysicsDirectSpaceState3D`, :ref:`PhysicsServer2D`, :ref:`PhysicsServer2DManager`, :ref:`PhysicsServer3D`, :ref:`PhysicsServer3DManager`, :ref:`PhysicsServer3DRenderingServerHandler`, :ref:`ProjectSettings`, :ref:`RefCounted`, :ref:`RenderData`, :ref:`RenderingDevice`, :ref:`RenderingServer`, :ref:`RenderSceneData`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`ResourceUID`, :ref:`ScriptLanguage`, :ref:`TextServerManager`, :ref:`ThemeDB`, :ref:`TileData`, :ref:`Time`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`UniformSetCacheRD`, :ref:`WorkerThreadPool`, :ref:`XRServer`, :ref:`XRVRS` Base class for all other classes in the engine. diff --git a/classes/class_openxrextensionwrapperextension.rst b/classes/class_openxrextensionwrapperextension.rst index a56a5d86fb9..6c883d55879 100644 --- a/classes/class_openxrextensionwrapperextension.rst +++ b/classes/class_openxrextensionwrapperextension.rst @@ -52,6 +52,8 @@ Methods +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_on_instance_destroyed`\ (\ ) |virtual| | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_main_swapchains_created`\ (\ ) |virtual| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_on_pre_render`\ (\ ) |virtual| | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_on_process`\ (\ ) |virtual| | @@ -248,6 +250,18 @@ Called right before the OpenXR instance is destroyed. ---- +.. _class_OpenXRExtensionWrapperExtension_private_method__on_main_swapchains_created: + +.. rst-class:: classref-method + +|void| **_on_main_swapchains_created**\ (\ ) |virtual| + +Called right after the main swapchains are (re)created. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRExtensionWrapperExtension_private_method__on_pre_render: .. rst-class:: classref-method diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 520acd54b4d..d3fb8f17410 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -1948,7 +1948,7 @@ The updown arrow icon to display for the :ref:`TreeItem.CELL_MODE_RANGE` **custom_button** -Default :ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` mode cell. +Default :ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` mode cell when button is enabled with :ref:`TreeItem.set_custom_as_button`. .. rst-class:: classref-item-separator @@ -1960,7 +1960,7 @@ Default :ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` **custom_button_hover** -:ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` mode cell when it's hovered. +:ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` mode button cell when it's hovered. .. rst-class:: classref-item-separator @@ -1972,7 +1972,7 @@ Default :ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` **custom_button_pressed** -:ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` mode cell when it's pressed. +:ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` mode button cell when it's pressed. .. rst-class:: classref-item-separator diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index bb16f96a809..2a4c0728a69 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -280,7 +280,7 @@ enum **TreeCellMode**: :ref:`TreeCellMode` **CELL_MODE_STRING** = ``0`` -Cell contains a string. +Cell shows a string label. When editable, the text can be edited using a :ref:`LineEdit`, or a :ref:`TextEdit` popup if :ref:`set_edit_multiline` is used. .. _class_TreeItem_constant_CELL_MODE_CHECK: @@ -288,7 +288,7 @@ Cell contains a string. :ref:`TreeCellMode` **CELL_MODE_CHECK** = ``1`` -Cell contains a checkbox. +Cell shows a checkbox, optionally with text. The checkbox can be pressed, released, or indeterminate (via :ref:`set_indeterminate`). The checkbox can't be clicked unless the cell is editable. .. _class_TreeItem_constant_CELL_MODE_RANGE: @@ -296,7 +296,9 @@ Cell contains a checkbox. :ref:`TreeCellMode` **CELL_MODE_RANGE** = ``2`` -Cell contains a range. +Cell shows a numeric range. When editable, it can be edited using a range slider. Use :ref:`set_range` to set the value and :ref:`set_range_config` to configure the range. + +This cell can also be used in a text dropdown mode when you assign a text with :ref:`set_text`. Separate options with a comma, e.g. ``"Option1,Option2,Option3"``. .. _class_TreeItem_constant_CELL_MODE_ICON: @@ -304,7 +306,7 @@ Cell contains a range. :ref:`TreeCellMode` **CELL_MODE_ICON** = ``3`` -Cell contains an icon. +Cell shows an icon. It can't be edited nor display text. .. _class_TreeItem_constant_CELL_MODE_CUSTOM: @@ -312,11 +314,9 @@ Cell contains an icon. :ref:`TreeCellMode` **CELL_MODE_CUSTOM** = ``4`` -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - +Cell shows as a clickable button. It will display an arrow similar to :ref:`OptionButton`, but doesn't feature a dropdown (for that you can use :ref:`CELL_MODE_RANGE`). Clicking the button emits the :ref:`Tree.item_edited` signal. The button is flat by default, you can use :ref:`set_custom_as_button` to display it with a :ref:`StyleBox`. +This mode also supports custom drawing using :ref:`set_custom_draw_callback`. .. rst-class:: classref-section-separator @@ -924,9 +924,7 @@ Returns a dictionary containing the range parameters for a given column. The key :ref:`StructuredTextParser` **get_structured_text_bidi_override**\ (\ column\: :ref:`int`\ ) |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the BiDi algorithm override set for this cell. .. rst-class:: classref-item-separator @@ -938,9 +936,7 @@ Returns a dictionary containing the range parameters for a given column. The key :ref:`Array` **get_structured_text_bidi_override_options**\ (\ column\: :ref:`int`\ ) |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the additional BiDi options set for this cell. .. rst-class:: classref-item-separator @@ -1074,9 +1070,7 @@ Returns ``true`` if the given ``column`` is checked. :ref:`bool` **is_custom_set_as_button**\ (\ column\: :ref:`int`\ ) |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if the cell was made into a button with :ref:`set_custom_as_button`. .. rst-class:: classref-item-separator @@ -1286,7 +1280,7 @@ Sets the tooltip text for the button at index ``button_index`` in the given ``co |void| **set_cell_mode**\ (\ column\: :ref:`int`, mode\: :ref:`TreeCellMode`\ ) -Sets the given column's cell mode to ``mode``. See :ref:`TreeCellMode` constants. +Sets the given column's cell mode to ``mode``. This determines how the cell is displayed and edited. See :ref:`TreeCellMode` constants for details. .. rst-class:: classref-item-separator @@ -1322,9 +1316,7 @@ Collapses or uncollapses this **TreeItem** and all the descendants of this item. |void| **set_custom_as_button**\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Makes a cell with :ref:`CELL_MODE_CUSTOM` display as a non-flat button with a :ref:`StyleBox`. .. rst-class:: classref-item-separator @@ -1376,7 +1368,7 @@ The method named ``callback`` should accept two arguments: the **TreeItem** that |void| **set_custom_draw_callback**\ (\ column\: :ref:`int`, callback\: :ref:`Callable`\ ) -Sets the given column's custom draw callback. Use an empty :ref:`Callable` (``Callable()``) to clear the custom callback. +Sets the given column's custom draw callback. Use an empty :ref:`Callable` (``Callable()``) to clear the custom callback. The cell has to be in :ref:`CELL_MODE_CUSTOM` to use this feature. The ``callback`` should accept two arguments: the **TreeItem** that is drawn and its position and size as a :ref:`Rect2`. @@ -1452,7 +1444,7 @@ If ``enable`` is ``true``, the given ``column`` is expanded to the right. |void| **set_icon**\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) -Sets the given column's icon :ref:`Texture2D`. +Sets the given cell's icon :ref:`Texture2D`. The cell has to be in :ref:`CELL_MODE_ICON` mode. .. rst-class:: classref-item-separator @@ -1576,9 +1568,7 @@ If ``selectable`` is ``true``, the given ``column`` is selectable. |void| **set_structured_text_bidi_override**\ (\ column\: :ref:`int`, parser\: :ref:`StructuredTextParser`\ ) -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Set BiDi algorithm override for the structured text. Has effect for cells that display text. .. rst-class:: classref-item-separator @@ -1590,9 +1580,7 @@ If ``selectable`` is ``true``, the given ``column`` is selectable. |void| **set_structured_text_bidi_override_options**\ (\ column\: :ref:`int`, args\: :ref:`Array`\ ) -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Set additional options for BiDi override. Has effect for cells that display text. .. rst-class:: classref-item-separator diff --git a/classes/index.rst b/classes/index.rst index 859af3a6b63..9d0275ef3dd 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -767,7 +767,6 @@ Other objects class_gdextensionmanager class_geometry2d class_geometry3d - class_godotsharp class_hashingcontext class_hmaccontext class_httpclient