NodeSocket(bpy_struct)

base class — bpy_struct

subclasses — NodeSocketStandard

class bpy.types.NodeSocket(bpy_struct)

Input or output socket of a node

bl_idname
Type:string, default “”, (never None)
display_shape

Socket shape

Type:enum in [‘CIRCLE’, ‘SQUARE’, ‘DIAMOND’, ‘CIRCLE_DOT’, ‘SQUARE_DOT’, ‘DIAMOND_DOT’], default ‘CIRCLE’
enabled

Enable the socket

Type:boolean, default False
hide

Hide the socket

Type:boolean, default False
hide_value

Hide the socket input value

Type:boolean, default False
identifier

Unique identifier for mapping sockets

Type:string, default “”, (readonly, never None)
is_linked

True if the socket is connected

Type:boolean, default False, (readonly)
is_output

True if the socket is an output, otherwise input

Type:boolean, default False, (readonly)
label

Custom dynamic defined socket label

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

Max number of links allowed for this socket

Type:int in [1, 4095], default 0
name

Socket name

Type:string, default “”, (never None)
node

Node owning this socket

Type:Node, (readonly)
show_expanded

Socket links are expanded in the user interface

Type:boolean, default False
type

Data type

Type:enum in [‘CUSTOM’, ‘VALUE’, ‘INT’, ‘BOOLEAN’, ‘VECTOR’, ‘STRING’, ‘RGBA’, ‘SHADER’], default ‘VALUE’

List of node links from or to this socket. Warning: takes O(len(nodetree.links)) time. (readonly)

draw(context, layout, node, text)

Draw socket

Parameters:
  • layout (UILayout, (never None)) – Layout, Layout in the UI
  • node (Node, (never None)) – Node, Node the socket belongs to
  • text (string, (never None)) – Text, Text label to draw alongside properties
draw_color(context, node)

Color of the socket icon

Parameters:node (Node, (never None)) – Node, Node the socket belongs to
Returns:Color
Return type:float array of 4 items in [0, 1]
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