Node(bpy_struct)

base class — bpy_struct

subclasses — NodeCustomGroup, NodeInternal

class bpy.types.Node(bpy_struct)

Node in a node tree

bl_description

(default “”, never None)

Type:

str

bl_height_default

(in [0, inf], default 0.0)

Type:

float

bl_height_max

(in [0, inf], default 0.0)

Type:

float

bl_height_min

(in [0, inf], default 0.0)

Type:

float

bl_icon

The node icon (default 'NODE')

Type:

Literal[Icon Items]

bl_idname

(default “”, never None)

Type:

str

bl_label

The node label (default “”, never None)

Type:

str

bl_static_type

Legacy unique node type identifier, redundant with bl_idname property (default “”, readonly, never None)

Type:

str

bl_width_default

(in [0, inf], default 0.0)

Type:

float

bl_width_max

(in [0, inf], default 0.0)

Type:

float

bl_width_min

(in [0, inf], default 0.0)

Type:

float

color

Custom color of the node body (array of 3 items, in [0, 1], default (0.0, 0.0, 0.0))

Type:

mathutils.Color

color_tag

Node header color tag (default 'NONE', readonly)

  • NONE None – Default color tag for new nodes and node groups.

  • ATTRIBUTE Attribute.

  • COLOR Color.

  • CONVERTER Converter.

  • DISTORT Distort.

  • FILTER Filter.

  • GEOMETRY Geometry.

  • INPUT Input.

  • MATTE Matte.

  • OUTPUT Output.

  • SCRIPT Script.

  • SHADER Shader.

  • TEXTURE Texture.

  • VECTOR Vector.

  • PATTERN Pattern.

  • INTERFACE Interface.

  • GROUP Group.

Type:

Literal[‘NONE’, ‘ATTRIBUTE’, ‘COLOR’, ‘CONVERTER’, ‘DISTORT’, ‘FILTER’, ‘GEOMETRY’, ‘INPUT’, ‘MATTE’, ‘OUTPUT’, ‘SCRIPT’, ‘SHADER’, ‘TEXTURE’, ‘VECTOR’, ‘PATTERN’, ‘INTERFACE’, ‘GROUP’]

dimensions

Absolute bounding box dimensions of the node (array of 2 items, in [-inf, inf], default (0.0, 0.0), readonly)

Type:

mathutils.Vector

height

Height of the node (in [-inf, inf], default 0.0)

Type:

float

hide

(default False)

Type:

bool

inputs

(default None, readonly)

Type:

NodeInputs[NodeSocket]

Internal input-to-output connections for muting (default None, readonly)

Type:

bpy_prop_collection[NodeLink]

label

Optional custom node label (default “”, never None)

Type:

str

location

Location of the node within its parent frame (array of 2 items, in [-1e+06, 1e+06], default (0.0, 0.0))

Type:

mathutils.Vector

location_absolute

Location of the node in the entire canvas (array of 2 items, in [-1e+06, 1e+06], default (0.0, 0.0))

Type:

mathutils.Vector

mute

(default False)

Type:

bool

name

Unique node identifier (default “”, never None)

Type:

str

outputs

(default None, readonly)

Type:

NodeOutputs[NodeSocket]

parent

Parent this node is attached to

Type:

Node

select

Node selection state (default False)

Type:

bool

show_options

(default False)

Type:

bool

show_preview

(default False)

Type:

bool

show_texture

Display node in viewport textured shading mode (default False)

Type:

bool

type

Legacy unique node type identifier, redundant with bl_idname property (default “”, readonly, never None)

Type:

str

use_custom_color

Use custom color for the node (default False)

Type:

bool

warning_propagation

The kinds of messages that should be propagated from this node to the parent group node (default 'ALL')

  • ALL All Messages – Propagate every info, error, and warning message upstream.

  • ERRORS_AND_WARNINGS Errors and Warnings – Propagate only error and warning messages upstream.

  • ERRORS Errors – Propagate only error messages upstream.

  • NONE None – Do not propagate any messages upstream.

Type:

Literal[‘ALL’, ‘ERRORS_AND_WARNINGS’, ‘ERRORS’, ‘NONE’]

width

Width of the node (in [-inf, inf], default 0.0)

Type:

float

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 (bool) – Ensure that system properties are created if they do not exist yet (optional)

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:

PropertyGroup

socket_value_update(context)

Update after property changes

Parameters:

context (Context) – (never None)

classmethod is_registered_node_type()

True if a registered node type

Returns:

Result

Return type:

bool

classmethod poll(node_tree)

If non-null output is returned, the node type can be added to the tree

Parameters:

node_tree (NodeTree) – Node Tree

Return type:

bool

poll_instance(node_tree)

If non-null output is returned, the node can be added to the tree

Parameters:

node_tree (NodeTree) – Node Tree

Return type:

bool

update()

Update on node graph topology changes (adding or removing nodes and links)

Handle creation of a link to or from the node

Parameters:

link (NodeLink) – Link, Node link that will be inserted (never None)

init(context)

Initialize a new instance of this node

Parameters:

context (Context) – (never None)

copy(node)

Initialize a new instance of this node from an existing node

Parameters:

node (Node) – Node, Existing node to copy (never None)

free()

Clean up node on removal

draw_buttons(context, layout)

Draw node buttons

Parameters:

  • context (Context) – (never None)

  • layout (UILayout) – Layout, Layout in the UI (never None)

draw_buttons_ext(context, layout)

Draw node buttons in the sidebar

Parameters:

  • context (Context) – (never None)

  • layout (UILayout) – Layout, Layout in the UI (never None)

draw_label()

Returns a dynamic label string

Returns:

Label, (never None)

Return type:

str

debug_zone_body_lazy_function_graph()

Get the internal lazy-function graph for the body of this zone

Returns:

Dot Graph, Graph in dot format

Return type:

str

debug_zone_lazy_function_graph()

Get the internal lazy-function graph for this zone

Returns:

Dot Graph, Graph in dot format

Return type:

str

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References