Class VisualShaderNodeGroupBase

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

Inheritance

VisualShaderNodeResizableBase

VisualShaderNode

Resource

RefCounted

Object

VisualShaderNodeGroupBase

Derived

VisualShaderNodeExpression

Remarks

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

Methods

add_input_port(int, int, String)

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

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

Parameters

id int

type int

name String

add_output_port(int, int, String)

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

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

Parameters

id int

type int

name String

clear_input_ports

Removes all previously specified input ports.

void clear_input_ports

clear_output_ports

Removes all previously specified output ports.

void clear_output_ports

get_free_input_port_id

Qualifiers: const

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

int get_free_input_port_id

get_free_output_port_id

Qualifiers: const

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

int get_free_output_port_id

get_input_port_count

Qualifiers: const

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

int get_input_port_count

get_inputs

Qualifiers: const

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

String get_inputs

get_output_port_count

Qualifiers: const

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

int get_output_port_count

get_outputs

Qualifiers: const

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

String get_outputs

has_input_port(int)

Qualifiers: const

Returns true if the specified input port exists.

bool has_input_port(int id)

Parameters

id int

has_output_port(int)

Qualifiers: const

Returns true if the specified output port exists.

bool has_output_port(int id)

Parameters

id int

is_valid_port_name(String)

Qualifiers: const

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

bool is_valid_port_name(String name)

Parameters

name String

remove_input_port(int)

Removes the specified input port.

void remove_input_port(int id)

Parameters

id int

remove_output_port(int)

Removes the specified output port.

void remove_output_port(int id)

Parameters

id int

set_input_port_name(int, String)

Renames the specified input port.

void set_input_port_name(int id, String name)

Parameters

id int

name String

set_input_port_type(int, int)

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

void set_input_port_type(int id, int type)

Parameters

id int

type int

set_inputs(String)

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

void set_inputs(String inputs)

Parameters

inputs String

set_output_port_name(int, String)

Renames the specified output port.

void set_output_port_name(int id, String name)

Parameters

id int

name String

set_output_port_type(int, int)

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

void set_output_port_type(int id, int type)

Parameters

id int

type int

set_outputs(String)

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

void set_outputs(String outputs)

Parameters

outputs String