classref: Sync with current master branch (46a568e0a)

This commit is contained in:
Rémi Verschelde
2022-08-31 15:18:54 +02:00
parent b08b95d4f5
commit 465dd176b6
378 changed files with 17124 additions and 13692 deletions

View File

@@ -29,6 +29,8 @@ Properties
+--------------------------------------------------+------------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`comment<class_GraphNode_property_comment>` | ``false`` |
+--------------------------------------------------+------------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`draggable<class_GraphNode_property_draggable>` | ``true`` |
+--------------------------------------------------+------------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`language<class_GraphNode_property_language>` | ``""`` |
+--------------------------------------------------+------------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`MouseFilter<enum_Control_MouseFilter>` | mouse_filter | ``0`` (overrides :ref:`Control<class_Control_property_mouse_filter>`) |
@@ -39,6 +41,8 @@ Properties
+--------------------------------------------------+------------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`resizable<class_GraphNode_property_resizable>` | ``false`` |
+--------------------------------------------------+------------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`selectable<class_GraphNode_property_selectable>` | ``true`` |
+--------------------------------------------------+------------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`selected<class_GraphNode_property_selected>` | ``false`` |
+--------------------------------------------------+------------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`show_close<class_GraphNode_property_show_close>` | ``false`` |
@@ -125,6 +129,8 @@ Theme Properties
+-----------------------------------+----------------------------------------------------------------------+-----------------------------------+
| :ref:`int<class_int>` | :ref:`separation<class_GraphNode_theme_constant_separation>` | ``2`` |
+-----------------------------------+----------------------------------------------------------------------+-----------------------------------+
| :ref:`int<class_int>` | :ref:`title_h_offset<class_GraphNode_theme_constant_title_h_offset>` | ``0`` |
+-----------------------------------+----------------------------------------------------------------------+-----------------------------------+
| :ref:`int<class_int>` | :ref:`title_offset<class_GraphNode_theme_constant_title_offset>` | ``26`` |
+-----------------------------------+----------------------------------------------------------------------+-----------------------------------+
| :ref:`Font<class_Font>` | :ref:`title_font<class_GraphNode_theme_font_title_font>` | |
@@ -237,6 +243,22 @@ If ``true``, the GraphNode is a comment node.
----
.. _class_GraphNode_property_draggable:
- :ref:`bool<class_bool>` **draggable**
+-----------+----------------------+
| *Default* | ``true`` |
+-----------+----------------------+
| *Setter* | set_draggable(value) |
+-----------+----------------------+
| *Getter* | is_draggable() |
+-----------+----------------------+
If ``true``, the user can drag the GraphNode.
----
.. _class_GraphNode_property_language:
- :ref:`String<class_String>` **language**
@@ -305,6 +327,22 @@ If ``true``, the user can resize the GraphNode.
----
.. _class_GraphNode_property_selectable:
- :ref:`bool<class_bool>` **selectable**
+-----------+-----------------------+
| *Default* | ``true`` |
+-----------+-----------------------+
| *Setter* | set_selectable(value) |
+-----------+-----------------------+
| *Getter* | is_selectable() |
+-----------+-----------------------+
If ``true``, the user can select the GraphNode.
----
.. _class_GraphNode_property_selected:
- :ref:`bool<class_bool>` **selected**
@@ -530,13 +568,13 @@ Returns ``true`` if right (output) side of the slot ``idx`` is enabled.
Sets properties of the slot with ID ``idx``.
If ``enable_left``/``right``, a port will appear and the slot will be able to be connected from this side.
If ``enable_left``/``enable_right``, a port will appear and the slot will be able to be connected from this side.
\ ``type_left``/``right`` is an arbitrary type of the port. Only ports with the same type values can be connected.
``type_left``/``type_right`` is an arbitrary type of the port. Only ports with the same type values can be connected and negative values will disallow all connections to be made via user inputs.
\ ``color_left``/``right`` is the tint of the port's icon on this side.
``color_left``/``color_right`` is the tint of the port's icon on this side.
\ ``custom_left``/``right`` is a custom texture for this side's port.
``custom_left``/``custom_right`` is a custom texture for this side's port.
\ **Note:** This method only sets properties of the slot. To create the slot, add a :ref:`Control<class_Control>`-derived child to the GraphNode.
@@ -588,7 +626,7 @@ Toggles the right (output) side of the slot ``idx``. If ``enable_right`` is ``tr
- void **set_slot_type_left** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` type_left **)**
Sets the left (input) type of the slot ``idx`` to ``type_left``.
Sets the left (input) type of the slot ``idx`` to ``type_left``. If the value is negative, all connections will be disallowed to be created via user inputs.
----
@@ -596,7 +634,7 @@ Sets the left (input) type of the slot ``idx`` to ``type_left``.
- void **set_slot_type_right** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` type_right **)**
Sets the right (output) type of the slot ``idx`` to ``type_right``.
Sets the right (output) type of the slot ``idx`` to ``type_right``. If the value is negative, all connections will be disallowed to be created via user inputs.
Theme Property Descriptions
---------------------------
@@ -683,6 +721,18 @@ The vertical distance between ports.
----
.. _class_GraphNode_theme_constant_title_h_offset:
- :ref:`int<class_int>` **title_h_offset**
+-----------+-------+
| *Default* | ``0`` |
+-----------+-------+
Horizontal offset of the title text.
----
.. _class_GraphNode_theme_constant_title_offset:
- :ref:`int<class_int>` **title_offset**