builder.interface

interface

Classes

Name	Description
InterfaceSocket	Base class for all node group interface socket definitions.
SocketBoolean	Boolean socket - true/false value.
SocketBundle	Bundle socket - holds multiple data types in one socket.
SocketClosure	Closure socket - holds shader closure data.
SocketCollection	Collection socket - Blender collection reference.
SocketColor	Color socket — also provides .r, .g, .b, .a.
SocketFloat	Float socket
SocketGeometry	Geometry socket - holds mesh, curve, point cloud, or volume data.
SocketImage	Image socket - Blender image datablock reference.
SocketInteger	Integer socket
SocketMaterial	Material socket - Blender material reference.
SocketMatrix	Matrix socket - 4x4 transformation matrix.
SocketMenu	Menu socket - holds a selection from predefined items.
SocketObject	Object socket - Blender object reference.
SocketRotation	Rotation socket - rotation value (Euler or Quaternion).
SocketShader	Shader that is the final output for a material
SocketString
SocketVector	Vector socket — also provides .x, .y, .z and vector math dispatch.

InterfaceSocket

InterfaceSocket(name, description='')

Base class for all node group interface socket definitions.

Extends Socket so that interface sockets behave like runtime sockets: they can be used directly in operator expressions, linked with >>, etc.

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`socket`
`socket_name`
`tree`
`type`

SocketBoolean

SocketBoolean(
    name='Boolean',
    default_value=False,
    description='',
    *,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
    structure_type='AUTO',
    layer_selection_field=False,
    attribute_domain='POINT',
    default_attribute=None,
    is_panel_toggle=False,
)

Boolean socket - true/false value.

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`socket`
`socket_name`
`tree`
`type`

SocketBundle

SocketBundle(
    name='Bundle',
    description='',
    *,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
)

Bundle socket - holds multiple data types in one socket.

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`socket`
`socket_name`
`tree`
`type`

SocketClosure

SocketClosure(
    name='Closure',
    description='',
    *,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
)

Closure socket - holds shader closure data.

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`socket`
`socket_name`
`tree`
`type`

SocketCollection

SocketCollection(
    name='Collection',
    default_value=None,
    description='',
    *,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
)

Collection socket - Blender collection reference.

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`socket`
`socket_name`
`tree`
`type`

SocketColor

SocketColor(
    name='Color',
    default_value=(1.0, 1.0, 1.0, 1.0),
    description='',
    *,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
    structure_type='AUTO',
    attribute_domain='POINT',
    default_attribute=None,
)

Color socket — also provides .r, .g, .b, .a.

Attributes

Name	Description
`a`
`b`
`default_value`
`description`
`g`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`r`
`socket`
`socket_name`
`tree`
`type`

SocketFloat

SocketFloat(
    name='Value',
    default_value=0.0,
    description='',
    *,
    min_value=None,
    max_value=None,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
    structure_type='AUTO',
    subtype='NONE',
    attribute_domain='POINT',
    default_attribute=None,
)

Float socket

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`socket`
`socket_name`
`tree`
`type`

SocketGeometry

SocketGeometry(
    name='Geometry',
    description='',
    *,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
)

Geometry socket - holds mesh, curve, point cloud, or volume data.

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`socket`
`socket_name`
`tree`
`type`

SocketImage

SocketImage(
    name='Image',
    default_value=None,
    description='',
    *,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
)

Image socket - Blender image datablock reference.

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`socket`
`socket_name`
`tree`
`type`

SocketInteger

SocketInteger(
    name='Integer',
    default_value=0,
    description='',
    *,
    min_value=-2147483648,
    max_value=2147483647,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
    structure_type='AUTO',
    default_input='VALUE',
    subtype='NONE',
    attribute_domain='POINT',
    default_attribute=None,
)

Integer socket

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`socket`
`socket_name`
`tree`
`type`

SocketMaterial

SocketMaterial(
    name='Material',
    default_value=None,
    description='',
    *,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
)

Material socket - Blender material reference.

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`socket`
`socket_name`
`tree`
`type`

SocketMatrix

SocketMatrix(
    name='Matrix',
    description='',
    *,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
    structure_type='AUTO',
    default_input='VALUE',
    attribute_domain='POINT',
    default_attribute=None,
)

Matrix socket - 4x4 transformation matrix.

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`rotation`
`scale`
`socket`
`socket_name`
`translation`
`tree`
`type`

SocketMenu

SocketMenu(
    name='Menu',
    default_value=None,
    description='',
    *,
    expanded=False,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
    structure_type='AUTO',
)

Menu socket - holds a selection from predefined items.

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`socket`
`socket_name`
`tree`
`type`

SocketObject

SocketObject(
    name='Object',
    default_value=None,
    description='',
    *,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
)

Object socket - Blender object reference.

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`socket`
`socket_name`
`tree`
`type`

SocketRotation

SocketRotation(
    name='Rotation',
    default_value=(0.0, 0.0, 0.0),
    description='',
    *,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
    structure_type='AUTO',
    attribute_domain='POINT',
    default_attribute=None,
)

Rotation socket - rotation value (Euler or Quaternion).

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`socket`
`socket_name`
`tree`
`type`
`w`
`x`
`y`
`z`

SocketShader

SocketShader(
    name='Shader',
    description='',
    *,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
)

Shader that is the final output for a material

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`socket`
`socket_name`
`tree`
`type`

SocketString

SocketString(
    name='String',
    default_value='',
    description='',
    *,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
    subtype='NONE',
)

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`socket`
`socket_name`
`tree`
`type`

SocketVector

SocketVector(
    name='Vector',
    default_value=(0.0, 0.0, 0.0),
    description='',
    *,
    dimensions=3,
    min_value=None,
    max_value=None,
    optional_label=False,
    hide_value=False,
    hide_in_modifier=False,
    structure_type='AUTO',
    subtype='NONE',
    default_attribute=None,
    default_input='VALUE',
    attribute_domain='POINT',
)

Vector socket — also provides .x, .y, .z and vector math dispatch.

Attributes

Name	Description
`default_value`
`description`
`inputs`
`interface_socket`
`links`
`name`
`node`
`outputs`
`socket`
`socket_name`
`tree`
`type`
`x`
`y`
`z`