Node(bpy_struct)#

base class — bpy_struct

subclasses — NodeCustomGroup, NodeInternal

class bpy.types.Node(bpy_struct)#

Node in a node tree

bl_description#
Type:

string, default “”, (never None)

bl_height_default#
Type:

float in [0, inf], default 0.0

bl_height_max#
Type:

float in [0, inf], default 0.0

bl_height_min#
Type:

float in [0, inf], default 0.0

bl_icon#

The node icon

Type:

enum in Icon Items, default ‘NODE’

bl_idname#
Type:

string, default “”, (never None)

bl_label#

The node label

Type:

string, default “”, (never None)

bl_static_type#

Node type (deprecated, use with care)

  • CUSTOM Custom – Custom Node.

Type:

enum in [‘CUSTOM’], default ‘CUSTOM’

bl_width_default#
Type:

float in [0, inf], default 0.0

bl_width_max#
Type:

float in [0, inf], default 0.0

bl_width_min#
Type:

float in [0, inf], default 0.0

color#

Custom color of the node body

Type:

mathutils.Color of 3 items in [0, 1], default (0.0, 0.0, 0.0)

dimensions#

Absolute bounding box dimensions of the node

Type:

mathutils.Vector of 2 items in [-inf, inf], default (0.0, 0.0), (readonly)

height#

Height of the node

Type:

float in [-inf, inf], default 0.0

hide#
Type:

boolean, default False

inputs#
Type:

NodeInputs bpy_prop_collection of NodeSocket, (readonly)

Internal input-to-output connections for muting

Type:

bpy_prop_collection of NodeLink, (readonly)

label#

Optional custom node label

Type:

string, default “”, (never None)

location#
Type:

mathutils.Vector of 2 items in [-100000, 100000], default (0.0, 0.0)

mute#
Type:

boolean, default False

name#

Unique node identifier

Type:

string, default “”, (never None)

outputs#
Type:

NodeOutputs bpy_prop_collection of NodeSocket, (readonly)

parent#

Parent this node is attached to

Type:

Node

select#

Node selection state

Type:

boolean, default False

show_options#
Type:

boolean, default False

show_preview#
Type:

boolean, default False

show_texture#

Display node in viewport textured shading mode

Type:

boolean, default False

type#

Node type (deprecated, use bl_static_type or bl_idname for the actual identifier string)

  • CUSTOM Custom – Custom Node.

Type:

enum in [‘CUSTOM’], default ‘CUSTOM’, (readonly)

use_custom_color#

Use custom color for the node

Type:

boolean, default False

width#

Width of the node

Type:

float in [-inf, inf], default 0.0

socket_value_update(context)#

Update after property changes

classmethod is_registered_node_type()#

True if a registered node type

Returns:

Result

Return type:

boolean

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:

boolean

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:

boolean

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, (never None)) – Link, Node link that will be inserted

init(context)#

Initialize a new instance of this node

copy(node)#

Initialize a new instance of this node from an existing node

Parameters:

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

free()#

Clean up node on removal

draw_buttons(context, layout)#

Draw node buttons

Parameters:

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

draw_buttons_ext(context, layout)#

Draw node buttons in the sidebar

Parameters:

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

draw_label()#

Returns a dynamic label string

Returns:

Label

Return type:

string, (never None)

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#