NodeTreeInterfaceSocket(NodeTreeInterfaceItem)

base classes — bpy_struct, NodeTreeInterfaceItem

subclasses — NodeTreeInterfaceSocketBool, NodeTreeInterfaceSocketBundle, NodeTreeInterfaceSocketClosure, NodeTreeInterfaceSocketCollection, NodeTreeInterfaceSocketColor, NodeTreeInterfaceSocketFloat, NodeTreeInterfaceSocketFloatAngle, NodeTreeInterfaceSocketFloatColorTemperature, NodeTreeInterfaceSocketFloatDistance, NodeTreeInterfaceSocketFloatFactor, NodeTreeInterfaceSocketFloatFrequency, NodeTreeInterfaceSocketFloatPercentage, NodeTreeInterfaceSocketFloatTime, NodeTreeInterfaceSocketFloatTimeAbsolute, NodeTreeInterfaceSocketFloatUnsigned, NodeTreeInterfaceSocketFloatWavelength, NodeTreeInterfaceSocketGeometry, NodeTreeInterfaceSocketImage, NodeTreeInterfaceSocketInt, NodeTreeInterfaceSocketIntFactor, NodeTreeInterfaceSocketIntPercentage, NodeTreeInterfaceSocketIntUnsigned, NodeTreeInterfaceSocketMaterial, NodeTreeInterfaceSocketMatrix, NodeTreeInterfaceSocketMenu, NodeTreeInterfaceSocketObject, NodeTreeInterfaceSocketRotation, NodeTreeInterfaceSocketShader, NodeTreeInterfaceSocketString, NodeTreeInterfaceSocketStringFilePath, NodeTreeInterfaceSocketTexture, NodeTreeInterfaceSocketVector, NodeTreeInterfaceSocketVector2D, NodeTreeInterfaceSocketVector4D, NodeTreeInterfaceSocketVectorAcceleration, NodeTreeInterfaceSocketVectorAcceleration2D, NodeTreeInterfaceSocketVectorAcceleration4D, NodeTreeInterfaceSocketVectorDirection, NodeTreeInterfaceSocketVectorDirection2D, NodeTreeInterfaceSocketVectorDirection4D, NodeTreeInterfaceSocketVectorEuler, NodeTreeInterfaceSocketVectorEuler2D, NodeTreeInterfaceSocketVectorEuler4D, NodeTreeInterfaceSocketVectorFactor, NodeTreeInterfaceSocketVectorFactor2D, NodeTreeInterfaceSocketVectorFactor4D, NodeTreeInterfaceSocketVectorPercentage, NodeTreeInterfaceSocketVectorPercentage2D, NodeTreeInterfaceSocketVectorPercentage4D, NodeTreeInterfaceSocketVectorTranslation, NodeTreeInterfaceSocketVectorTranslation2D, NodeTreeInterfaceSocketVectorTranslation4D, NodeTreeInterfaceSocketVectorVelocity, NodeTreeInterfaceSocketVectorVelocity2D, NodeTreeInterfaceSocketVectorVelocity4D, NodeTreeInterfaceSocketVectorXYZ, NodeTreeInterfaceSocketVectorXYZ2D, NodeTreeInterfaceSocketVectorXYZ4D

class bpy.types.NodeTreeInterfaceSocket(NodeTreeInterfaceItem)

Declaration of a node socket

attribute_domain

Attribute domain used by the geometry nodes modifier to create an attribute output

Type:

enum in Attribute Domain Items, default "'POINT'"

bl_socket_idname

Name of the socket type

Type:

string, default “”, (never None)

default_attribute_name

The attribute name used by default when the node group is used by a geometry nodes modifier

Type:

string, default “”, (never None)

default_input

Input to use when the socket is unconnected. Requires “Hide Value”.

  • VALUE Default Value – The node socket’s default value.

  • INDEX Index – The index from the context.

  • ID_OR_INDEX ID or Index – The “id” attribute if available, otherwise the index.

  • NORMAL Normal – The geometry’s normal direction.

  • POSITION Position – The position from the context.

  • INSTANCE_TRANSFORM Instance Transform – Transformation of each instance from the geometry context.

  • HANDLE_LEFT Left Handle – The left Bézier control point handle from the context.

  • HANDLE_RIGHT Right Handle – The right Bézier control point handle from the context.

Type:

enum in ['VALUE', 'INDEX', 'ID_OR_INDEX', 'NORMAL', 'POSITION', 'INSTANCE_TRANSFORM', 'HANDLE_LEFT', 'HANDLE_RIGHT'], default "'VALUE'"

description

Socket description

Type:

string, default “”, (never None)

force_non_field

Only allow single value inputs rather than field. Deprecated. Will be remove in 5.0.

Type:

boolean, default False

hide_in_modifier

Don’t show the input value in the geometry nodes modifier interface

Type:

boolean, default False

hide_value

Hide the socket input value even when the socket is not connected

Type:

boolean, default False

identifier

Unique identifier for mapping sockets

Type:

string, default “”, (readonly, never None)

in_out

Input or output socket type

  • INPUT Input – Generate a input node socket.

  • OUTPUT Output – Generate a output node socket.

Type:

enum in ['INPUT', 'OUTPUT'], default "'INPUT'", (readonly)

is_inspect_output

Take link out of node group to connect to root tree output node

Type:

boolean, default False

is_panel_toggle

This socket is meant to be used as the toggle in its panel header

Type:

boolean, default False

layer_selection_field

Take Grease Pencil Layer or Layer Group as selection field

Type:

boolean, default False

menu_expanded

Draw the menu socket as an expanded drop-down menu

Type:

boolean, default False

name

Socket name

Type:

string, default “”, (never None)

optional_label

Indicate that the label of this socket is not necessary to understand its meaning. This may result in the label being skipped in some cases

Type:

boolean, default False

socket_type

Type of the socket generated by this interface item

Type:

enum in ['DEFAULT'], default "'DEFAULT'"

structure_type

What kind of higher order types are expected to flow through this socket

Type:

enum in Node Socket Structure Type Items, default "'AUTO'"

bl_system_properties_get(*, do_create=False)

DEBUG ONLY. Internal access to runtime-defined RNA data storage, intended solely for testing and debugging purposes. Do not access it in regular scripting work, and in particular, do not assume that it contains writable data

Parameters:

do_create (boolean, (optional)) – Ensure that system properties are created if they do not exist yet

Returns:

The system properties root container, or None if there are no system properties stored in this data yet, and its creation was not requested

Return type:

PropertyGroup

draw(context, layout)

Draw properties of the socket interface

Parameters:

layout (UILayout, (never None)) – Layout, Layout in the UI

init_socket(node, socket, data_path)

Initialize a node socket instance

Parameters:

  • node (Node, (never None)) – Node, Node of the socket to initialize

  • socket (NodeSocket, (never None)) – Socket, Socket to initialize

  • data_path (string, (never None)) – Data Path, Path to specialized socket data

from_socket(node, socket)

Setup template parameters from an existing socket

Parameters:

  • node (Node, (never None)) – Node, Node of the original socket

  • socket (NodeSocket, (never None)) – Socket, Original socket

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

id (str) – The RNA type identifier.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

id (str) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References