NodeTreeInterfaceSocket(NodeTreeInterfaceItem)#

base classes — bpy_struct, NodeTreeInterfaceItem

subclasses — NodeTreeInterfaceSocketBool, NodeTreeInterfaceSocketCollection, NodeTreeInterfaceSocketColor, NodeTreeInterfaceSocketFloat, NodeTreeInterfaceSocketFloatAngle, NodeTreeInterfaceSocketFloatDistance, NodeTreeInterfaceSocketFloatFactor, NodeTreeInterfaceSocketFloatPercentage, NodeTreeInterfaceSocketFloatTime, NodeTreeInterfaceSocketFloatTimeAbsolute, NodeTreeInterfaceSocketFloatUnsigned, NodeTreeInterfaceSocketGeometry, NodeTreeInterfaceSocketImage, NodeTreeInterfaceSocketInt, NodeTreeInterfaceSocketIntFactor, NodeTreeInterfaceSocketIntPercentage, NodeTreeInterfaceSocketIntUnsigned, NodeTreeInterfaceSocketMaterial, NodeTreeInterfaceSocketMenu, NodeTreeInterfaceSocketObject, NodeTreeInterfaceSocketRotation, NodeTreeInterfaceSocketShader, NodeTreeInterfaceSocketString, NodeTreeInterfaceSocketTexture, NodeTreeInterfaceSocketVector, NodeTreeInterfaceSocketVectorAcceleration, NodeTreeInterfaceSocketVectorDirection, NodeTreeInterfaceSocketVectorEuler, NodeTreeInterfaceSocketVectorTranslation, NodeTreeInterfaceSocketVectorVelocity, NodeTreeInterfaceSocketVectorXYZ

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”

Type:

enum in [], default ‘’

description#

Socket description

Type:

string, default “”, (never None)

force_non_field#

Only allow single value inputs rather than fields

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)

layer_selection_field#

Take Grease Pencil Layer or Layer Group as selection field

Type:

boolean, default False

name#

Socket name

Type:

string, default “”, (never None)

socket_type#

Type of the socket generated by this interface item

Type:

enum in [‘DEFAULT’], default ‘DEFAULT’

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 (string) – 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 (string) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References