Class reference

VisualShaderNodeGroupBase

Inherits VisualShaderNodeResizableBase

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

Description

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

Methods

`void add_input_port(int id, int type, String name)`

Adds an input port with the specified type (see VisualShaderNode.PortType) and name.

`void add_output_port(int id, int type, String name)`

Adds an output port with the specified type (see VisualShaderNode.PortType) and name.

`void clear_input_ports()`

Removes all previously specified input ports.

`void clear_output_ports()`

Removes all previously specified output ports.

`int get_free_input_port_id() const`

Returns a free input port ID which can be used in add_input_port().

`int get_free_output_port_id() const`

Returns a free output port ID which can be used in add_output_port().

`int get_input_port_count() const`

Returns the number of input ports in use. Alternative for get_free_input_port_id().

`String get_inputs() const`

Returns a String description of the input ports as a colon-separated list using the format id,type,name; (see add_input_port()).

`int get_output_port_count() const`

Returns the number of output ports in use. Alternative for get_free_output_port_id().

`String get_outputs() const`

Returns a String description of the output ports as a colon-separated list using the format id,type,name; (see add_output_port()).

`bool has_input_port(int id) const`

Returns true if the specified input port exists.

`bool has_output_port(int id) const`

Returns true if the specified output port exists.

`bool is_valid_port_name(String name) const`

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

`void remove_input_port(int id)`

Removes the specified input port.

`void remove_output_port(int id)`

Removes the specified output port.

`void set_input_port_name(int id, String name)`

Renames the specified input port.

`void set_input_port_type(int id, int type)`

Sets the specified input port's type (see VisualShaderNode.PortType).

`void set_inputs(String inputs)`

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

`void set_output_port_name(int id, String name)`

Renames the specified output port.

`void set_output_port_type(int id, int type)`

Sets the specified output port's type (see VisualShaderNode.PortType).

`void set_outputs(String outputs)`

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

Source revision 5592dc3a7a61