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)
- bl_label
Label to display for the socket type in the UI
- Type
string, default “”, (never None)
- bl_subtype_label
Label to display for the socket subtype in the UI
- Type
string, default “”, (never None)
- description
Socket tooltip
- 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)
- inferred_structure_type
Best known structure type of the socket. This may not match the socket shape, e.g. for unlinked input sockets
- Type
enum in Node Socket Structure Type Items, default
"'AUTO'", (readonly)
- is_icon_visible
Socket is drawn as interactive icon in the node editor
- Type
boolean, default False, (readonly)
- is_inactive
Socket is grayed out because it has been detected to not have any effect on the output
- Type
boolean, default False, (readonly)
- is_linked
True if the socket is connected
- Type
boolean, default False, (readonly)
- is_multi_input
True if the socket can accept multiple ordered input links
- Type
boolean, default False, (readonly)
- is_output
True if the socket is an output, otherwise input
- Type
boolean, default False, (readonly)
True if the socket is unavailable
- Type
boolean, default False, (readonly)
- label
Custom dynamic defined socket label
- Type
string, default “”, (readonly, never None)
- 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)
- pin_gizmo
Keep gizmo visible even when the node is not selected
- Type
boolean, default False
- select
True if the socket is selected
- Type
boolean, default False, (readonly)
- show_expanded
Socket links are expanded in the user interface
- Type
boolean, default False
- type
Data type
- Type
enum in Node Socket Type Items, default
"'VALUE'"
- links
List of node links from or to this socket.
- Type
Note
Takes
O(len(nodetree.links))time.(readonly)
- 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 (boolean, (optional)) – Ensure that system properties are created if they do not exist yet
- 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
- draw(context, layout, node, text)
Draw socket
- 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 draw_color_simple()
Color of the socket icon. Used to draw sockets in places where the socket does not belong to a node, like the node interface panel. Also used to draw node sockets if draw_color is not defined.
- Returns
Color
- Return type
float array of 4 items in [0, 1]
- classmethod bl_rna_get_subclass(id, default=None, /)
- Parameters
id (str) – The RNA type identifier.
- Returns
The RNA type or default when not found.
- Return type
bpy.types.Structsubclass