372 lines
18 KiB
ReStructuredText
372 lines
18 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeGroupBase.xml.
|
|
|
|
.. _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.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Currently, has no direct usage, use the derived classes instead.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------------+------------------------------------------------------------+---------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`size<class_VisualShaderNodeGroupBase_property_size>` | ``Vector2( 0, 0 )`` |
|
|
+-------------------------------+------------------------------------------------------------+---------------------+
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Methods
|
|
-------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 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 **)** |
|
|
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_VisualShaderNodeGroupBase_property_size:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Vector2<class_Vector2>` **size** = ``Vector2( 0, 0 )``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_size** **(** :ref:`Vector2<class_Vector2>` value **)**
|
|
- :ref:`Vector2<class_Vector2>` **get_size** **(** **)**
|
|
|
|
The size of the node in the visual shader graph.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_add_input_port:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
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``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_add_output_port:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
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``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_clear_input_ports:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **clear_input_ports** **(** **)**
|
|
|
|
Removes all previously specified input ports.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_clear_output_ports:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **clear_output_ports** **(** **)**
|
|
|
|
Removes all previously specified output ports.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_get_free_input_port_id:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
: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>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_get_free_output_port_id:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
: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>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_get_input_port_count:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
: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>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_get_inputs:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
: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>`).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_get_output_port_count:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
: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>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_get_outputs:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
: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>`).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_has_input_port:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`bool<class_bool>` **has_input_port** **(** :ref:`int<class_int>` id **)** |const|
|
|
|
|
Returns ``true`` if the specified input port exists.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_has_output_port:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`bool<class_bool>` **has_output_port** **(** :ref:`int<class_int>` id **)** |const|
|
|
|
|
Returns ``true`` if the specified output port exists.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_is_valid_port_name:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
: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.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_remove_input_port:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **remove_input_port** **(** :ref:`int<class_int>` id **)**
|
|
|
|
Removes the specified input port.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_remove_output_port:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **remove_output_port** **(** :ref:`int<class_int>` id **)**
|
|
|
|
Removes the specified output port.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_set_input_port_name:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **set_input_port_name** **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**
|
|
|
|
Renames the specified input port.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_set_input_port_type:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
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>`).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_set_inputs:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
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>`).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_set_output_port_name:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **set_output_port_name** **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**
|
|
|
|
Renames the specified output port.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_set_output_port_type:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
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>`).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeGroupBase_method_set_outputs:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
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.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|