godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (03e6fbb)

Browse Source
This commit is contained in:
Godot Organization
2024-05-04 03:20:12 +00:00
parent 4d925dd274
commit a7e99ea017
43 changed files with 4431 additions and 531 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
classes/class_statusindicator.rst
View File

@@ -27,13 +27,27 @@ Properties
.. table::
:widths: auto
+-----------------------------+--------------------------------------------------------+----------+
| :ref:`Image<class_Image>` | :ref:`icon<class_StatusIndicator_property_icon>` | |
+-----------------------------+--------------------------------------------------------+----------+
| :ref:`String<class_String>` | :ref:`tooltip<class_StatusIndicator_property_tooltip>` | ``""`` |
+-----------------------------+--------------------------------------------------------+----------+
| :ref:`bool<class_bool>` | :ref:`visible<class_StatusIndicator_property_visible>` | ``true`` |
+-----------------------------+--------------------------------------------------------+----------+
+-----------------------------------+--------------------------------------------------------+------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`icon<class_StatusIndicator_property_icon>` | |
+-----------------------------------+--------------------------------------------------------+------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`menu<class_StatusIndicator_property_menu>` | ``NodePath("")`` |
+-----------------------------------+--------------------------------------------------------+------------------+
| :ref:`String<class_String>` | :ref:`tooltip<class_StatusIndicator_property_tooltip>` | ``""`` |
+-----------------------------------+--------------------------------------------------------+------------------+
| :ref:`bool<class_bool>` | :ref:`visible<class_StatusIndicator_property_visible>` | ``true`` |
+-----------------------------------+--------------------------------------------------------+------------------+
.. rst-class:: classref-reftable-group
Methods
-------
.. table::
:widths: auto
+---------------------------+----------------------------------------------------------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`get_rect<class_StatusIndicator_method_get_rect>`\ (\ ) |const| |
+---------------------------+----------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@@ -65,12 +79,12 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`Image<class_Image>` **icon**
:ref:`Texture2D<class_Texture2D>` **icon**
.. rst-class:: classref-property-setget
- |void| **set_icon**\ (\ value\: :ref:`Image<class_Image>`\ )
- :ref:`Image<class_Image>` **get_icon**\ (\ )
- |void| **set_icon**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
- :ref:`Texture2D<class_Texture2D>` **get_icon**\ (\ )
Status indicator icon.
@@ -78,6 +92,25 @@ Status indicator icon.
----
.. _class_StatusIndicator_property_menu:
.. rst-class:: classref-property
:ref:`NodePath<class_NodePath>` **menu** = ``NodePath("")``
.. rst-class:: classref-property-setget
- |void| **set_menu**\ (\ value\: :ref:`NodePath<class_NodePath>`\ )
- :ref:`NodePath<class_NodePath>` **get_menu**\ (\ )
Status indicator native popup menu. If this is set, the :ref:`pressed<class_StatusIndicator_signal_pressed>` signal is not emitted.
\ **Note:** Native popup is only supported if :ref:`NativeMenu<class_NativeMenu>` supports :ref:`NativeMenu.FEATURE_POPUP_MENU<class_NativeMenu_constant_FEATURE_POPUP_MENU>` feature.
.. rst-class:: classref-item-separator
----
.. _class_StatusIndicator_property_tooltip:
.. rst-class:: classref-property
@@ -108,6 +141,23 @@ Status indicator tooltip.
If ``true``, the status indicator is visible.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_StatusIndicator_method_get_rect:
.. rst-class:: classref-method
:ref:`Rect2<class_Rect2>` **get_rect**\ (\ ) |const|
Returns the status indicator rectangle in screen coordinates. If this status indicator is not visible, returns an empty :ref:`Rect2<class_Rect2>`.
.. |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.)`