2019-05-28 18:08:13 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2021-03-23 13:40:34 +01:00
<class name= "VisualShaderNodeGroupBase" inherits= "VisualShaderNode" version= "3.3" >
2019-05-28 18:08:13 +02:00
<brief_description >
2020-01-27 16:14:10 +01:00
Base class for a family of nodes with variable amount of input and output ports within the visual shader graph.
2019-05-28 18:08:13 +02:00
</brief_description>
<description >
2020-01-27 16:14:10 +01:00
Currently, has no direct usage, use the derived classes instead.
2019-05-28 18:08:13 +02:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "add_input_port" >
<return type= "void" >
</return>
<argument index= "0" name= "id" type= "int" >
</argument>
<argument index= "1" name= "type" type= "int" >
</argument>
<argument index= "2" name= "name" type= "String" >
</argument>
<description >
2020-01-27 16:14:10 +01:00
Adds an input port with the specified [code]type[/code] (see [enum VisualShaderNode.PortType]) and [code]name[/code].
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "add_output_port" >
<return type= "void" >
</return>
<argument index= "0" name= "id" type= "int" >
</argument>
<argument index= "1" name= "type" type= "int" >
</argument>
<argument index= "2" name= "name" type= "String" >
</argument>
<description >
2020-01-27 16:14:10 +01:00
Adds an output port with the specified [code]type[/code] (see [enum VisualShaderNode.PortType]) and [code]name[/code].
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "clear_input_ports" >
<return type= "void" >
</return>
<description >
2020-01-27 16:14:10 +01:00
Removes all previously specified input ports.
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "clear_output_ports" >
<return type= "void" >
</return>
<description >
2020-01-27 16:14:10 +01:00
Removes all previously specified output ports.
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "get_free_input_port_id" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2020-01-27 16:14:10 +01:00
Returns a free input port ID which can be used in [method add_input_port].
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "get_free_output_port_id" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2020-01-27 16:14:10 +01:00
Returns a free output port ID which can be used in [method add_output_port].
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "get_input_port_count" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2020-01-27 16:14:10 +01:00
Returns the number of input ports in use. Alternative for [method get_free_input_port_id].
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "get_inputs" qualifiers= "const" >
<return type= "String" >
</return>
<description >
2020-01-27 16:14:10 +01:00
Returns a [String] description of the input ports as as colon-separated list using the format [code]id,type,name;[/code] (see [method add_input_port]).
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "get_output_port_count" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2020-01-27 16:14:10 +01:00
Returns the number of output ports in use. Alternative for [method get_free_output_port_id].
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "get_outputs" qualifiers= "const" >
<return type= "String" >
</return>
<description >
2020-01-27 16:14:10 +01:00
Returns a [String] description of the output ports as as colon-separated list using the format [code]id,type,name;[/code] (see [method add_output_port]).
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "has_input_port" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "id" type= "int" >
</argument>
<description >
2020-01-27 16:14:10 +01:00
Returns [code]true[/code] if the specified input port exists.
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "has_output_port" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "id" type= "int" >
</argument>
<description >
2020-01-27 16:14:10 +01:00
Returns [code]true[/code] if the specified output port exists.
2019-05-28 18:08:13 +02:00
</description>
</method>
2019-06-24 10:39:59 +02:00
<method name= "is_valid_port_name" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "name" type= "String" >
</argument>
<description >
2020-01-27 16:14:10 +01:00
Returns [code]true[/code] if the specified port name does not override an existed port name and is valid within the shader.
2019-06-24 10:39:59 +02:00
</description>
</method>
2019-05-28 18:08:13 +02:00
<method name= "remove_input_port" >
<return type= "void" >
</return>
<argument index= "0" name= "id" type= "int" >
</argument>
<description >
2020-01-27 16:14:10 +01:00
Removes the specified input port.
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "remove_output_port" >
<return type= "void" >
</return>
<argument index= "0" name= "id" type= "int" >
</argument>
<description >
2020-01-27 16:14:10 +01:00
Removes the specified output port.
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "set_input_port_name" >
<return type= "void" >
</return>
2019-09-24 11:44:48 +02:00
<argument index= "0" name= "id" type= "int" >
2019-05-28 18:08:13 +02:00
</argument>
2019-09-24 11:44:48 +02:00
<argument index= "1" name= "name" type= "String" >
2019-05-28 18:08:13 +02:00
</argument>
<description >
2020-01-27 16:14:10 +01:00
Renames the specified input port.
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "set_input_port_type" >
<return type= "void" >
</return>
2019-09-24 11:44:48 +02:00
<argument index= "0" name= "id" type= "int" >
2019-05-28 18:08:13 +02:00
</argument>
2019-09-24 11:44:48 +02:00
<argument index= "1" name= "type" type= "int" >
2019-05-28 18:08:13 +02:00
</argument>
<description >
2020-01-27 16:14:10 +01:00
Sets the specified input port's type (see [enum VisualShaderNode.PortType]).
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "set_inputs" >
<return type= "void" >
</return>
<argument index= "0" name= "inputs" type= "String" >
</argument>
<description >
2020-01-27 16:14:10 +01:00
Defines all input ports using a [String] formatted as a colon-separated list: [code]id,type,name;[/code] (see [method add_input_port]).
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "set_output_port_name" >
<return type= "void" >
</return>
2019-09-24 11:44:48 +02:00
<argument index= "0" name= "id" type= "int" >
2019-05-28 18:08:13 +02:00
</argument>
2019-09-24 11:44:48 +02:00
<argument index= "1" name= "name" type= "String" >
2019-05-28 18:08:13 +02:00
</argument>
<description >
2020-01-27 16:14:10 +01:00
Renames the specified output port.
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "set_output_port_type" >
<return type= "void" >
</return>
2019-09-24 11:44:48 +02:00
<argument index= "0" name= "id" type= "int" >
2019-05-28 18:08:13 +02:00
</argument>
2019-09-24 11:44:48 +02:00
<argument index= "1" name= "type" type= "int" >
2019-05-28 18:08:13 +02:00
</argument>
<description >
2020-01-27 16:14:10 +01:00
Sets the specified output port's type (see [enum VisualShaderNode.PortType]).
2019-05-28 18:08:13 +02:00
</description>
</method>
<method name= "set_outputs" >
<return type= "void" >
</return>
<argument index= "0" name= "outputs" type= "String" >
</argument>
<description >
2020-01-27 16:14:10 +01:00
Defines all output ports using a [String] formatted as a colon-separated list: [code]id,type,name;[/code] (see [method add_output_port]).
2019-05-28 18:08:13 +02:00
</description>
</method>
</methods>
2019-08-22 14:49:30 +02:00
<members >
2020-01-27 16:46:35 +01:00
<member name= "size" type= "Vector2" setter= "set_size" getter= "get_size" default= "Vector2( 0, 0 )" >
2020-01-27 16:14:10 +01:00
The size of the node in the visual shader graph.
2020-01-27 16:46:35 +01:00
</member>
2019-08-22 14:49:30 +02:00
</members>
2019-05-28 18:08:13 +02:00
<constants >
</constants>
</class>