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)

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)

link_limit

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’

links

List of node links from or to this socket (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]

Inherited Properties

bpy_struct.id_data

Inherited Functions

bpy_struct.as_pointer bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete

bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.property_unset bpy_struct.type_recast bpy_struct.values

References

CompositorNodeOutputFileFileSlots.new CompositorNodeOutputFileFileSlots.remove CompositorNodeOutputFileLayerSlots.new CompositorNodeOutputFileLayerSlots.remove Node.inputs Node.outputs NodeInputs.new NodeInputs.remove NodeLink.from_socket

NodeLink.to_socket NodeLinks.new NodeLinks.new NodeOutputs.new NodeOutputs.remove NodeSocketInterface.from_socket NodeSocketInterface.init_socket UILayout.template_node_link UILayout.template_node_view