godot-docs/classes/class_visualshadernodegroupbase.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualShaderNodeGroupBase.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_VisualShaderNodeGroupBase:

VisualShaderNodeGroupBase
=========================

**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Inherited By:** :ref:`VisualShaderNodeExpression<class_VisualShaderNodeExpression>`



Properties
----------

+---------------------------+--------------------------------------------------------------------+-----------------+
| :ref:`Array<class_Array>` | default_input_values                                               | **O:** ``[  ]`` |
+---------------------------+--------------------------------------------------------------------+-----------------+
| :ref:`bool<class_bool>`   | :ref:`editable<class_VisualShaderNodeGroupBase_property_editable>` | ``false``       |
+---------------------------+--------------------------------------------------------------------+-----------------+

Methods
-------

+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`add_input_port<class_VisualShaderNodeGroupBase_method_add_input_port>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type, :ref:`String<class_String>` name **)**   |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`add_output_port<class_VisualShaderNodeGroupBase_method_add_output_port>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type, :ref:`String<class_String>` name **)** |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`clear_input_ports<class_VisualShaderNodeGroupBase_method_clear_input_ports>` **(** **)**                                                                                    |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`clear_output_ports<class_VisualShaderNodeGroupBase_method_clear_output_ports>` **(** **)**                                                                                  |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Control<class_Control>` | :ref:`get_control<class_VisualShaderNodeGroupBase_method_get_control>` **(** :ref:`int<class_int>` index **)**                                                                    |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`         | :ref:`get_free_input_port_id<class_VisualShaderNodeGroupBase_method_get_free_input_port_id>` **(** **)** const                                                                    |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`         | :ref:`get_free_output_port_id<class_VisualShaderNodeGroupBase_method_get_free_output_port_id>` **(** **)** const                                                                  |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`         | :ref:`get_input_port_count<class_VisualShaderNodeGroupBase_method_get_input_port_count>` **(** **)** const                                                                        |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`   | :ref:`get_inputs<class_VisualShaderNodeGroupBase_method_get_inputs>` **(** **)** const                                                                                            |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`         | :ref:`get_output_port_count<class_VisualShaderNodeGroupBase_method_get_output_port_count>` **(** **)** const                                                                      |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`   | :ref:`get_outputs<class_VisualShaderNodeGroupBase_method_get_outputs>` **(** **)** const                                                                                          |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_size<class_VisualShaderNodeGroupBase_method_get_size>` **(** **)** const                                                                                                |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`       | :ref:`has_input_port<class_VisualShaderNodeGroupBase_method_has_input_port>` **(** :ref:`int<class_int>` id **)** const                                                           |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`       | :ref:`has_output_port<class_VisualShaderNodeGroupBase_method_has_output_port>` **(** :ref:`int<class_int>` id **)** const                                                         |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`       | :ref:`is_valid_port_name<class_VisualShaderNodeGroupBase_method_is_valid_port_name>` **(** :ref:`String<class_String>` name **)** const                                           |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`remove_input_port<class_VisualShaderNodeGroupBase_method_remove_input_port>` **(** :ref:`int<class_int>` id **)**                                                           |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`remove_output_port<class_VisualShaderNodeGroupBase_method_remove_output_port>` **(** :ref:`int<class_int>` id **)**                                                         |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`set_control<class_VisualShaderNodeGroupBase_method_set_control>` **(** :ref:`Control<class_Control>` control, :ref:`int<class_int>` index **)**                             |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`set_input_port_name<class_VisualShaderNodeGroupBase_method_set_input_port_name>` **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**                     |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`set_input_port_type<class_VisualShaderNodeGroupBase_method_set_input_port_type>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type **)**                           |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`set_inputs<class_VisualShaderNodeGroupBase_method_set_inputs>` **(** :ref:`String<class_String>` inputs **)**                                                               |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`set_output_port_name<class_VisualShaderNodeGroupBase_method_set_output_port_name>` **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**                   |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`set_output_port_type<class_VisualShaderNodeGroupBase_method_set_output_port_type>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type **)**                         |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`set_outputs<class_VisualShaderNodeGroupBase_method_set_outputs>` **(** :ref:`String<class_String>` outputs **)**                                                            |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`set_size<class_VisualShaderNodeGroupBase_method_set_size>` **(** :ref:`Vector2<class_Vector2>` size **)**                                                                   |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Property Descriptions
---------------------

.. _class_VisualShaderNodeGroupBase_property_editable:

- :ref:`bool<class_bool>` **editable**

+-----------+---------------------+
| *Default* | ``false``           |
+-----------+---------------------+
| *Setter*  | set_editable(value) |
+-----------+---------------------+
| *Getter*  | is_editable()       |
+-----------+---------------------+

Method Descriptions
-------------------

.. _class_VisualShaderNodeGroupBase_method_add_input_port:

- void **add_input_port** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type, :ref:`String<class_String>` name **)**

----

.. _class_VisualShaderNodeGroupBase_method_add_output_port:

- void **add_output_port** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type, :ref:`String<class_String>` name **)**

----

.. _class_VisualShaderNodeGroupBase_method_clear_input_ports:

- void **clear_input_ports** **(** **)**

----

.. _class_VisualShaderNodeGroupBase_method_clear_output_ports:

- void **clear_output_ports** **(** **)**

----

.. _class_VisualShaderNodeGroupBase_method_get_control:

- :ref:`Control<class_Control>` **get_control** **(** :ref:`int<class_int>` index **)**

----

.. _class_VisualShaderNodeGroupBase_method_get_free_input_port_id:

- :ref:`int<class_int>` **get_free_input_port_id** **(** **)** const

----

.. _class_VisualShaderNodeGroupBase_method_get_free_output_port_id:

- :ref:`int<class_int>` **get_free_output_port_id** **(** **)** const

----

.. _class_VisualShaderNodeGroupBase_method_get_input_port_count:

- :ref:`int<class_int>` **get_input_port_count** **(** **)** const

----

.. _class_VisualShaderNodeGroupBase_method_get_inputs:

- :ref:`String<class_String>` **get_inputs** **(** **)** const

----

.. _class_VisualShaderNodeGroupBase_method_get_output_port_count:

- :ref:`int<class_int>` **get_output_port_count** **(** **)** const

----

.. _class_VisualShaderNodeGroupBase_method_get_outputs:

- :ref:`String<class_String>` **get_outputs** **(** **)** const

----

.. _class_VisualShaderNodeGroupBase_method_get_size:

- :ref:`Vector2<class_Vector2>` **get_size** **(** **)** const

----

.. _class_VisualShaderNodeGroupBase_method_has_input_port:

- :ref:`bool<class_bool>` **has_input_port** **(** :ref:`int<class_int>` id **)** const

----

.. _class_VisualShaderNodeGroupBase_method_has_output_port:

- :ref:`bool<class_bool>` **has_output_port** **(** :ref:`int<class_int>` id **)** const

----

.. _class_VisualShaderNodeGroupBase_method_is_valid_port_name:

- :ref:`bool<class_bool>` **is_valid_port_name** **(** :ref:`String<class_String>` name **)** const

----

.. _class_VisualShaderNodeGroupBase_method_remove_input_port:

- void **remove_input_port** **(** :ref:`int<class_int>` id **)**

----

.. _class_VisualShaderNodeGroupBase_method_remove_output_port:

- void **remove_output_port** **(** :ref:`int<class_int>` id **)**

----

.. _class_VisualShaderNodeGroupBase_method_set_control:

- void **set_control** **(** :ref:`Control<class_Control>` control, :ref:`int<class_int>` index **)**

----

.. _class_VisualShaderNodeGroupBase_method_set_input_port_name:

- void **set_input_port_name** **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**

----

.. _class_VisualShaderNodeGroupBase_method_set_input_port_type:

- void **set_input_port_type** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type **)**

----

.. _class_VisualShaderNodeGroupBase_method_set_inputs:

- void **set_inputs** **(** :ref:`String<class_String>` inputs **)**

----

.. _class_VisualShaderNodeGroupBase_method_set_output_port_name:

- void **set_output_port_name** **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**

----

.. _class_VisualShaderNodeGroupBase_method_set_output_port_type:

- void **set_output_port_type** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type **)**

----

.. _class_VisualShaderNodeGroupBase_method_set_outputs:

- void **set_outputs** **(** :ref:`String<class_String>` outputs **)**

----

.. _class_VisualShaderNodeGroupBase_method_set_size:

- void **set_size** **(** :ref:`Vector2<class_Vector2>` size **)**