NodeTreeInterfaceSocket(NodeTreeInterfaceItem)

base classes — bpy_struct, NodeTreeInterfaceItem

subclasses — NodeTreeInterfaceSocketBool, NodeTreeInterfaceSocketBundle, NodeTreeInterfaceSocketClosure, NodeTreeInterfaceSocketCollection, NodeTreeInterfaceSocketColor, NodeTreeInterfaceSocketFloat, NodeTreeInterfaceSocketFloatAngle, NodeTreeInterfaceSocketFloatColorTemperature, NodeTreeInterfaceSocketFloatDistance, NodeTreeInterfaceSocketFloatFactor, NodeTreeInterfaceSocketFloatFrequency, NodeTreeInterfaceSocketFloatMass, NodeTreeInterfaceSocketFloatPercentage, NodeTreeInterfaceSocketFloatTime, NodeTreeInterfaceSocketFloatTimeAbsolute, NodeTreeInterfaceSocketFloatUnsigned, NodeTreeInterfaceSocketFloatWavelength, NodeTreeInterfaceSocketFont, NodeTreeInterfaceSocketGeometry, NodeTreeInterfaceSocketImage, NodeTreeInterfaceSocketInt, NodeTreeInterfaceSocketIntFactor, NodeTreeInterfaceSocketIntPercentage, NodeTreeInterfaceSocketIntUnsigned, NodeTreeInterfaceSocketMask, NodeTreeInterfaceSocketMaterial, NodeTreeInterfaceSocketMatrix, NodeTreeInterfaceSocketMenu, NodeTreeInterfaceSocketObject, NodeTreeInterfaceSocketRotation, NodeTreeInterfaceSocketScene, NodeTreeInterfaceSocketShader, NodeTreeInterfaceSocketSound, NodeTreeInterfaceSocketString, NodeTreeInterfaceSocketStringFilePath, NodeTreeInterfaceSocketText, 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 (default 'POINT')

Type:

Literal[Attribute Domain Items]

bl_socket_idname

Name of the socket type (default “”, never None)

Type:

str

default_attribute_name

The attribute name used by default when the node group is used by a geometry nodes modifier (default “”, never None)

Type:

str

default_input

Input to use when the socket is unconnected. Requires “Hide Value”. (default '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:

Literal[‘VALUE’, ‘INDEX’, ‘ID_OR_INDEX’, ‘NORMAL’, ‘POSITION’, ‘INSTANCE_TRANSFORM’, ‘HANDLE_LEFT’, ‘HANDLE_RIGHT’]

description

Socket description (default “”, never None)

Type:

str

force_non_field

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

(default False)

Type:

bool

hide_in_modifier

Don’t show the input value in the geometry nodes modifier interface (default False)

Type:

bool

hide_value

Hide the socket input value even when the socket is not connected (default False)

Type:

bool

identifier

Unique identifier for mapping sockets (default “”, readonly, never None)

Type:

str

in_out

Input or output socket type (default 'INPUT', readonly)

  • INPUT Input – Generate a input node socket.

  • OUTPUT Output – Generate a output node socket.

Type:

Literal[‘INPUT’, ‘OUTPUT’]

is_inspect_output

Take link out of node group to connect to root tree output node (default False)

Type:

bool

is_panel_toggle

This socket is meant to be used as the toggle in its panel header (default False)

Type:

bool

layer_selection_field

Take Grease Pencil Layer or Layer Group as selection field (default False)

Type:

bool

menu_expanded

Draw the menu socket as an expanded drop-down menu (default False)

Type:

bool

name

Socket name (default “”, never None)

Type:

str

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 (default False)

Type:

bool

select

Socket is selected in the interface (default False)

Type:

bool

socket_type

Type of the socket generated by this interface item (default 'DEFAULT')

Type:

Literal[‘DEFAULT’]

structure_type

What kind of higher order types are expected to flow through this socket (default 'AUTO')

Type:

Literal[Node Socket Structure Type Items]

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 (bool) – Ensure that system properties are created if they do not exist yet (optional)

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:

  • context (Context) – (never None)

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

init_socket(node, socket, data_path)

Initialize a node socket instance

Parameters:

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

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

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

from_socket(node, socket)

Setup template parameters from an existing socket

Parameters:

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

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

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

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

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

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References