mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
classref: Add property overview and setter/getter like in editor docs
Output from godotengine/godot#22013. Fixes #1729.
This commit is contained in:
@@ -8,6 +8,7 @@ GraphNode
|
||||
=========
|
||||
|
||||
**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
|
||||
@@ -15,6 +16,25 @@ Brief Description
|
||||
|
||||
A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types.
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------+-----------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`comment<class_GraphNode_comment>` |
|
||||
+----------------------------------------+-----------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_GraphNode_offset>` |
|
||||
+----------------------------------------+-----------------------------------------------+
|
||||
| :ref:`Overlay<enum_GraphNode_Overlay>` | :ref:`overlay<class_GraphNode_overlay>` |
|
||||
+----------------------------------------+-----------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`resizable<class_GraphNode_resizable>` |
|
||||
+----------------------------------------+-----------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`selected<class_GraphNode_selected>` |
|
||||
+----------------------------------------+-----------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`show_close<class_GraphNode_show_close>` |
|
||||
+----------------------------------------+-----------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`title<class_GraphNode_title>` |
|
||||
+----------------------------------------+-----------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
@@ -54,50 +74,87 @@ Methods
|
||||
| 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 **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Theme Properties
|
||||
----------------
|
||||
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`breakpoint<class_GraphNode_breakpoint>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`close<class_GraphNode_close>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`close_offset<class_GraphNode_close_offset>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`comment<class_GraphNode_comment>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`commentfocus<class_GraphNode_commentfocus>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`defaultfocus<class_GraphNode_defaultfocus>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`defaultframe<class_GraphNode_defaultframe>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`frame<class_GraphNode_frame>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`port<class_GraphNode_port>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`port_offset<class_GraphNode_port_offset>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`position<class_GraphNode_position>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`resizer<class_GraphNode_resizer>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`selectedframe<class_GraphNode_selectedframe>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`separation<class_GraphNode_separation>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`title_color<class_GraphNode_title_color>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`Font<class_Font>` | :ref:`title_font<class_GraphNode_title_font>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`title_offset<class_GraphNode_title_offset>` |
|
||||
+---------------------------------+-----------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_GraphNode_close_request:
|
||||
.. _class_GraphNode_close_request:
|
||||
|
||||
- **close_request** **(** **)**
|
||||
|
||||
Signal sent on closing the GraphNode.
|
||||
|
||||
.. _class_GraphNode_dragged:
|
||||
.. _class_GraphNode_dragged:
|
||||
|
||||
- **dragged** **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to **)**
|
||||
|
||||
Signal sent when the GraphNode is dragged.
|
||||
|
||||
.. _class_GraphNode_offset_changed:
|
||||
.. _class_GraphNode_offset_changed:
|
||||
|
||||
- **offset_changed** **(** **)**
|
||||
|
||||
Signal sent when the GraphNode is moved.
|
||||
|
||||
.. _class_GraphNode_raise_request:
|
||||
.. _class_GraphNode_raise_request:
|
||||
|
||||
- **raise_request** **(** **)**
|
||||
|
||||
Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode.
|
||||
|
||||
.. _class_GraphNode_resize_request:
|
||||
.. _class_GraphNode_resize_request:
|
||||
|
||||
- **resize_request** **(** :ref:`Vector2<class_Vector2>` new_minsize **)**
|
||||
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_GraphNode_Overlay:
|
||||
|
||||
enum **Overlay**
|
||||
enum **Overlay**:
|
||||
|
||||
- **OVERLAY_DISABLED** = **0**
|
||||
- **OVERLAY_BREAKPOINT** = **1**
|
||||
- **OVERLAY_POSITION** = **2**
|
||||
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
@@ -110,132 +167,174 @@ Property Descriptions
|
||||
|
||||
- :ref:`bool<class_bool>` **comment**
|
||||
|
||||
+----------+--------------------+
|
||||
| *Setter* | set_comment(value) |
|
||||
+----------+--------------------+
|
||||
| *Getter* | is_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>`.
|
||||
- :ref:`Vector2<class_Vector2>` **offset**
|
||||
|
||||
+----------+-------------------+
|
||||
| *Setter* | set_offset(value) |
|
||||
+----------+-------------------+
|
||||
| *Getter* | get_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**
|
||||
|
||||
+----------+--------------------+
|
||||
| *Setter* | set_overlay(value) |
|
||||
+----------+--------------------+
|
||||
| *Getter* | get_overlay() |
|
||||
+----------+--------------------+
|
||||
|
||||
.. _class_GraphNode_resizable:
|
||||
|
||||
- :ref:`bool<class_bool>` **resizable**
|
||||
|
||||
+----------+----------------------+
|
||||
| *Setter* | set_resizable(value) |
|
||||
+----------+----------------------+
|
||||
| *Getter* | is_resizable() |
|
||||
+----------+----------------------+
|
||||
|
||||
.. _class_GraphNode_selected:
|
||||
|
||||
- :ref:`bool<class_bool>` **selected**
|
||||
|
||||
+----------+---------------------+
|
||||
| *Setter* | set_selected(value) |
|
||||
+----------+---------------------+
|
||||
| *Getter* | is_selected() |
|
||||
+----------+---------------------+
|
||||
|
||||
.. _class_GraphNode_show_close:
|
||||
|
||||
- :ref:`bool<class_bool>` **show_close**
|
||||
|
||||
+----------+------------------------------+
|
||||
| *Setter* | set_show_close_button(value) |
|
||||
+----------+------------------------------+
|
||||
| *Getter* | is_close_button_visible() |
|
||||
+----------+------------------------------+
|
||||
|
||||
.. _class_GraphNode_title:
|
||||
|
||||
- :ref:`String<class_String>` **title**
|
||||
|
||||
+----------+------------------+
|
||||
| *Setter* | set_title(value) |
|
||||
+----------+------------------+
|
||||
| *Getter* | get_title() |
|
||||
+----------+------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_GraphNode_clear_all_slots:
|
||||
.. _class_GraphNode_clear_all_slots:
|
||||
|
||||
- void **clear_all_slots** **(** **)**
|
||||
|
||||
Disable all input and output slots of the GraphNode.
|
||||
|
||||
.. _class_GraphNode_clear_slot:
|
||||
.. _class_GraphNode_clear_slot:
|
||||
|
||||
- void **clear_slot** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Disable input and output slot whose index is 'idx'.
|
||||
|
||||
.. _class_GraphNode_get_connection_input_color:
|
||||
.. _class_GraphNode_get_connection_input_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **get_connection_input_color** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Return the color of the input connection 'idx'.
|
||||
|
||||
.. _class_GraphNode_get_connection_input_count:
|
||||
.. _class_GraphNode_get_connection_input_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_connection_input_count** **(** **)**
|
||||
|
||||
Return the number of enabled input slots (connections) to the GraphNode.
|
||||
|
||||
.. _class_GraphNode_get_connection_input_position:
|
||||
.. _class_GraphNode_get_connection_input_position:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **get_connection_input_position** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Return the position of the input connection 'idx'.
|
||||
|
||||
.. _class_GraphNode_get_connection_input_type:
|
||||
.. _class_GraphNode_get_connection_input_type:
|
||||
|
||||
- :ref:`int<class_int>` **get_connection_input_type** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Return the type of the input connection 'idx'.
|
||||
|
||||
.. _class_GraphNode_get_connection_output_color:
|
||||
.. _class_GraphNode_get_connection_output_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **get_connection_output_color** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Return the color of the output connection 'idx'.
|
||||
|
||||
.. _class_GraphNode_get_connection_output_count:
|
||||
.. _class_GraphNode_get_connection_output_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_connection_output_count** **(** **)**
|
||||
|
||||
Return the number of enabled output slots (connections) of the GraphNode.
|
||||
|
||||
.. _class_GraphNode_get_connection_output_position:
|
||||
.. _class_GraphNode_get_connection_output_position:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **get_connection_output_position** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Return the position of the output connection 'idx'.
|
||||
|
||||
.. _class_GraphNode_get_connection_output_type:
|
||||
.. _class_GraphNode_get_connection_output_type:
|
||||
|
||||
- :ref:`int<class_int>` **get_connection_output_type** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Return the type of the output connection 'idx'.
|
||||
|
||||
.. _class_GraphNode_get_slot_color_left:
|
||||
.. _class_GraphNode_get_slot_color_left:
|
||||
|
||||
- :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:
|
||||
.. _class_GraphNode_get_slot_color_right:
|
||||
|
||||
- :ref:`Color<class_Color>` **get_slot_color_right** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return the color set to 'idx' right (output) slot.
|
||||
|
||||
.. _class_GraphNode_get_slot_type_left:
|
||||
.. _class_GraphNode_get_slot_type_left:
|
||||
|
||||
- :ref:`int<class_int>` **get_slot_type_left** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return the (integer) type of left (input) 'idx' slot.
|
||||
|
||||
.. _class_GraphNode_get_slot_type_right:
|
||||
.. _class_GraphNode_get_slot_type_right:
|
||||
|
||||
- :ref:`int<class_int>` **get_slot_type_right** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return the (integer) type of right (output) 'idx' slot.
|
||||
|
||||
.. _class_GraphNode_is_slot_enabled_left:
|
||||
.. _class_GraphNode_is_slot_enabled_left:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_slot_enabled_left** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return true if left (input) slot 'idx' is enabled. False otherwise.
|
||||
|
||||
.. _class_GraphNode_is_slot_enabled_right:
|
||||
.. _class_GraphNode_is_slot_enabled_right:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_slot_enabled_right** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return true if right (output) slot 'idx' is enabled. False otherwise.
|
||||
|
||||
.. _class_GraphNode_set_slot:
|
||||
.. _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 **)**
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user