NodeSocketInterface(bpy_struct)

base class — bpy_struct

subclasses — NodeSocketInterfaceStandard

class bpy.types.NodeSocketInterface(bpy_struct)

Parameters to define node sockets

bl_socket_idname
Type:string, default “”, (never None)
identifier

Unique identifier for mapping sockets

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

True if the socket is an output, otherwise input

Type:boolean, default False, (readonly)
name

Socket name

Type:string, default “”, (never None)
draw(context, layout)

Draw template settings

Parameters:layout (UILayout, (never None)) – Layout, Layout in the UI
draw_color(context)

Color of the socket icon

Returns:Color
Return type:float array of 4 items in [0, 1]
register_properties(data_rna_type)

Define RNA properties of a socket

Parameters:data_rna_type (Struct) – Data RNA Type, RNA type for special socket properties
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