godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
							:github_url: hide

.. Generated automatically by doc/tools/make_rst.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>`

Base class for a family of nodes with variable amount of input and output ports within the visual shader graph.

Description
-----------

Currently, has no direct usage, use the derived classes instead.

Properties
----------

+-------------------------------+------------------------------------------------------------+---------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`size<class_VisualShaderNodeGroupBase_property_size>` | ``Vector2( 0, 0 )`` |
+-------------------------------+------------------------------------------------------------+---------------------+

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:`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:`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_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 **)**                                                            |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

.. _class_VisualShaderNodeGroupBase_property_size:

- :ref:`Vector2<class_Vector2>` **size**

+-----------+---------------------+
| *Default* | ``Vector2( 0, 0 )`` |
+-----------+---------------------+
| *Setter*  | set_size(value)     |
+-----------+---------------------+
| *Getter*  | get_size()          |
+-----------+---------------------+

The size of the node in the visual shader graph.

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 **)**

Adds an input port with the specified ``type`` (see :ref:`PortType<enum_VisualShaderNode_PortType>`) and ``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 **)**

Adds an output port with the specified ``type`` (see :ref:`PortType<enum_VisualShaderNode_PortType>`) and ``name``.

----

.. _class_VisualShaderNodeGroupBase_method_clear_input_ports:

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

Removes all previously specified input ports.

----

.. _class_VisualShaderNodeGroupBase_method_clear_output_ports:

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

Removes all previously specified output ports.

----

.. _class_VisualShaderNodeGroupBase_method_get_free_input_port_id:

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

Returns a free input port ID which can be used in :ref:`add_input_port<class_VisualShaderNodeGroupBase_method_add_input_port>`.

----

.. _class_VisualShaderNodeGroupBase_method_get_free_output_port_id:

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

Returns a free output port ID which can be used in :ref:`add_output_port<class_VisualShaderNodeGroupBase_method_add_output_port>`.

----

.. _class_VisualShaderNodeGroupBase_method_get_input_port_count:

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

Returns the number of input ports in use. Alternative for :ref:`get_free_input_port_id<class_VisualShaderNodeGroupBase_method_get_free_input_port_id>`.

----

.. _class_VisualShaderNodeGroupBase_method_get_inputs:

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

Returns a :ref:`String<class_String>` description of the input ports as a colon-separated list using the format ``id,type,name;`` (see :ref:`add_input_port<class_VisualShaderNodeGroupBase_method_add_input_port>`).

----

.. _class_VisualShaderNodeGroupBase_method_get_output_port_count:

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

Returns the number of output ports in use. Alternative for :ref:`get_free_output_port_id<class_VisualShaderNodeGroupBase_method_get_free_output_port_id>`.

----

.. _class_VisualShaderNodeGroupBase_method_get_outputs:

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

Returns a :ref:`String<class_String>` description of the output ports as a colon-separated list using the format ``id,type,name;`` (see :ref:`add_output_port<class_VisualShaderNodeGroupBase_method_add_output_port>`).

----

.. _class_VisualShaderNodeGroupBase_method_has_input_port:

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

Returns ``true`` if the specified input port exists.

----

.. _class_VisualShaderNodeGroupBase_method_has_output_port:

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

Returns ``true`` if the specified output port exists.

----

.. _class_VisualShaderNodeGroupBase_method_is_valid_port_name:

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

Returns ``true`` if the specified port name does not override an existed port name and is valid within the shader.

----

.. _class_VisualShaderNodeGroupBase_method_remove_input_port:

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

Removes the specified input port.

----

.. _class_VisualShaderNodeGroupBase_method_remove_output_port:

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

Removes the specified output port.

----

.. _class_VisualShaderNodeGroupBase_method_set_input_port_name:

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

Renames the specified input port.

----

.. _class_VisualShaderNodeGroupBase_method_set_input_port_type:

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

Sets the specified input port's type (see :ref:`PortType<enum_VisualShaderNode_PortType>`).

----

.. _class_VisualShaderNodeGroupBase_method_set_inputs:

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

Defines all input ports using a :ref:`String<class_String>` formatted as a colon-separated list: ``id,type,name;`` (see :ref:`add_input_port<class_VisualShaderNodeGroupBase_method_add_input_port>`).

----

.. _class_VisualShaderNodeGroupBase_method_set_output_port_name:

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

Renames the specified output port.

----

.. _class_VisualShaderNodeGroupBase_method_set_output_port_type:

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

Sets the specified output port's type (see :ref:`PortType<enum_VisualShaderNode_PortType>`).

----

.. _class_VisualShaderNodeGroupBase_method_set_outputs:

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

Defines all output ports using a :ref:`String<class_String>` formatted as a colon-separated list: ``id,type,name;`` (see :ref:`add_output_port<class_VisualShaderNodeGroupBase_method_add_output_port>`).

.. |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.)`