mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 18:29:11 +00:00
classref: Fix links case and sync headers with editor
Output from godotengine/godot#22002.
This commit is contained in:
Rémi Verschelde
+55
-56
@@ -7,8 +7,7 @@
|
||||
GraphNode
|
||||
=========
|
||||
|
||||
**Inherits:** :ref:`Container<class_container>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherits:** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
@@ -16,33 +15,33 @@ Brief Description
|
||||
|
||||
A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_all_slots<class_GraphNode_clear_all_slots>` **(** **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_slot<class_GraphNode_clear_slot>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_connection_input_color<class_GraphNode_get_connection_input_color>` **(** :ref:`int<class_int>` idx **)** |
|
||||
| :ref:`Color<class_Color>` | :ref:`get_connection_input_color<class_GraphNode_get_connection_input_color>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_connection_input_count<class_GraphNode_get_connection_input_count>` **(** **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_connection_input_position<class_GraphNode_get_connection_input_position>` **(** :ref:`int<class_int>` idx **)** |
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_connection_input_position<class_GraphNode_get_connection_input_position>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_connection_input_type<class_GraphNode_get_connection_input_type>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_connection_output_color<class_GraphNode_get_connection_output_color>` **(** :ref:`int<class_int>` idx **)** |
|
||||
| :ref:`Color<class_Color>` | :ref:`get_connection_output_color<class_GraphNode_get_connection_output_color>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_connection_output_count<class_GraphNode_get_connection_output_count>` **(** **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_connection_output_position<class_GraphNode_get_connection_output_position>` **(** :ref:`int<class_int>` idx **)** |
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_connection_output_position<class_GraphNode_get_connection_output_position>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_connection_output_type<class_GraphNode_get_connection_output_type>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_slot_color_left<class_GraphNode_get_slot_color_left>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
| :ref:`Color<class_Color>` | :ref:`get_slot_color_left<class_GraphNode_get_slot_color_left>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_slot_color_right<class_GraphNode_get_slot_color_right>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
| :ref:`Color<class_Color>` | :ref:`get_slot_color_right<class_GraphNode_get_slot_color_right>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_slot_type_left<class_GraphNode_get_slot_type_left>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -52,7 +51,7 @@ Member Functions
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_slot_enabled_right<class_GraphNode_is_slot_enabled_right>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_slot<class_GraphNode_set_slot>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_color>` color_right, :ref:`Texture<class_texture>` custom_left=null, :ref:`Texture<class_texture>` custom_right=null **)** |
|
||||
| void | :ref:`set_slot<class_GraphNode_set_slot>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_Color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_Color>` color_right, :ref:`Texture<class_Texture>` custom_left=null, :ref:`Texture<class_Texture>` custom_right=null **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
@@ -66,7 +65,7 @@ Signal sent on closing the GraphNode.
|
||||
|
||||
.. _class_GraphNode_dragged:
|
||||
|
||||
- **dragged** **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to **)**
|
||||
- **dragged** **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to **)**
|
||||
|
||||
Signal sent when the GraphNode is dragged.
|
||||
|
||||
@@ -84,43 +83,11 @@ Signal sent when the GraphNode is requested to be displayed over other ones. Hap
|
||||
|
||||
.. _class_GraphNode_resize_request:
|
||||
|
||||
- **resize_request** **(** :ref:`Vector2<class_vector2>` new_minsize **)**
|
||||
- **resize_request** **(** :ref:`Vector2<class_Vector2>` new_minsize **)**
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
.. _class_GraphNode_comment:
|
||||
|
||||
- :ref:`bool<class_bool>` **comment**
|
||||
|
||||
.. _class_GraphNode_offset:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **offset** - The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdit<class_graphedit>`. Note that you cannot use position directly, as :ref:`GraphEdit<class_graphedit>` is a :ref:`Container<class_container>`.
|
||||
|
||||
.. _class_GraphNode_overlay:
|
||||
|
||||
- :ref:`Overlay<enum_graphnode_overlay>` **overlay**
|
||||
|
||||
.. _class_GraphNode_resizable:
|
||||
|
||||
- :ref:`bool<class_bool>` **resizable**
|
||||
|
||||
.. _class_GraphNode_selected:
|
||||
|
||||
- :ref:`bool<class_bool>` **selected**
|
||||
|
||||
.. _class_GraphNode_show_close:
|
||||
|
||||
- :ref:`bool<class_bool>` **show_close**
|
||||
|
||||
.. _class_GraphNode_title:
|
||||
|
||||
- :ref:`String<class_string>` **title**
|
||||
|
||||
|
||||
Enums
|
||||
-----
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_GraphNode_Overlay:
|
||||
|
||||
@@ -136,8 +103,40 @@ Description
|
||||
|
||||
A GraphNode is a container defined by a title. It can have 1 or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_GraphNode_comment:
|
||||
|
||||
- :ref:`bool<class_bool>` **comment**
|
||||
|
||||
.. _class_GraphNode_offset:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **offset** - The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdit<class_GraphEdit>`. Note that you cannot use position directly, as :ref:`GraphEdit<class_GraphEdit>` is a :ref:`Container<class_Container>`.
|
||||
|
||||
.. _class_GraphNode_overlay:
|
||||
|
||||
- :ref:`Overlay<enum_GraphNode_Overlay>` **overlay**
|
||||
|
||||
.. _class_GraphNode_resizable:
|
||||
|
||||
- :ref:`bool<class_bool>` **resizable**
|
||||
|
||||
.. _class_GraphNode_selected:
|
||||
|
||||
- :ref:`bool<class_bool>` **selected**
|
||||
|
||||
.. _class_GraphNode_show_close:
|
||||
|
||||
- :ref:`bool<class_bool>` **show_close**
|
||||
|
||||
.. _class_GraphNode_title:
|
||||
|
||||
- :ref:`String<class_String>` **title**
|
||||
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_GraphNode_clear_all_slots:
|
||||
|
||||
@@ -153,7 +152,7 @@ Disable input and output slot whose index is 'idx'.
|
||||
|
||||
.. _class_GraphNode_get_connection_input_color:
|
||||
|
||||
- :ref:`Color<class_color>` **get_connection_input_color** **(** :ref:`int<class_int>` idx **)**
|
||||
- :ref:`Color<class_Color>` **get_connection_input_color** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Return the color of the input connection 'idx'.
|
||||
|
||||
@@ -165,7 +164,7 @@ Return the number of enabled input slots (connections) to the GraphNode.
|
||||
|
||||
.. _class_GraphNode_get_connection_input_position:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_connection_input_position** **(** :ref:`int<class_int>` idx **)**
|
||||
- :ref:`Vector2<class_Vector2>` **get_connection_input_position** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Return the position of the input connection 'idx'.
|
||||
|
||||
@@ -177,7 +176,7 @@ Return the type of the input connection 'idx'.
|
||||
|
||||
.. _class_GraphNode_get_connection_output_color:
|
||||
|
||||
- :ref:`Color<class_color>` **get_connection_output_color** **(** :ref:`int<class_int>` idx **)**
|
||||
- :ref:`Color<class_Color>` **get_connection_output_color** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Return the color of the output connection 'idx'.
|
||||
|
||||
@@ -189,7 +188,7 @@ Return the number of enabled output slots (connections) of the GraphNode.
|
||||
|
||||
.. _class_GraphNode_get_connection_output_position:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_connection_output_position** **(** :ref:`int<class_int>` idx **)**
|
||||
- :ref:`Vector2<class_Vector2>` **get_connection_output_position** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Return the position of the output connection 'idx'.
|
||||
|
||||
@@ -201,13 +200,13 @@ Return the type of the output connection 'idx'.
|
||||
|
||||
.. _class_GraphNode_get_slot_color_left:
|
||||
|
||||
- :ref:`Color<class_color>` **get_slot_color_left** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`Color<class_Color>` **get_slot_color_left** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return the color set to 'idx' left (input) slot.
|
||||
|
||||
.. _class_GraphNode_get_slot_color_right:
|
||||
|
||||
- :ref:`Color<class_color>` **get_slot_color_right** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`Color<class_Color>` **get_slot_color_right** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return the color set to 'idx' right (output) slot.
|
||||
|
||||
@@ -237,6 +236,6 @@ Return true if right (output) slot 'idx' is enabled. False otherwise.
|
||||
|
||||
.. _class_GraphNode_set_slot:
|
||||
|
||||
- void **set_slot** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_color>` color_right, :ref:`Texture<class_texture>` custom_left=null, :ref:`Texture<class_texture>` custom_right=null **)**
|
||||
- void **set_slot** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_Color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_Color>` color_right, :ref:`Texture<class_Texture>` custom_left=null, :ref:`Texture<class_Texture>` custom_right=null **)**
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user