Function reference

Attribute

For interacting with attributes on meshes

named_attribute	Get the named attribute data from the object.
store_named_attribute	Adds and sets the values of an attribute on the object.
remove_named_attribute	Remove a named attribute from an object.
AttributeDomains	Enumeration of attribute domains in Blender. You can store an attribute onto one of
AttributeTypes	Enumeration of attribute types in Blender.
AttributeArray	A numpy array subclass that automatically syncs changes back to the Blender object.

Collections

Working with collections in Blender

create_collection	Create a new Blender collection or retrieve an existing one.
move_to_collection	Move one or many objects into a target collection.

Objects

create_object	Create a new Blender mesh object.
create_mesh_object	Create a new Blender mesh object.
create_curves_object	Create a new Blender curves object (new Curves type, not legacy Curve).
create_pointcloud_object	Create a new Blender point cloud object.
create_bob	Create a BlenderObject wrapper around a new Blender mesh object.
evaluate_object	Return an object which has the modifiers evaluated.
GeometrySet	Access the evaluated geometry of an object (bpy.types.GeometrySet).
BlenderObject	A convenience class for working with Blender objects.
BlenderObjectAttribute	Minimal base class for Blender objects with attribute access.
BlenderObjectBase	Minimal base class for Blender objects with name and object access.
LinkedObjectError	Error raised when a Python object doesn’t have a linked object in the 3D scene.

Utilities

Typed helpers that check for None or narrow data-block types, plus general utilities

require	Return the given value, raising an error if it is None.
require_data	Return the object’s data-block, checked to be of the given type.
mesh_data	Return the object’s data-block, checked to be a Mesh.
curves_data	Return the object’s data-block, checked to be a Curves.
pointcloud_data	Return the object’s data-block, checked to be a PointCloud.
volume_data	Return the object’s data-block, checked to be a Volume.
active_scene	Return the active scene, raising an error if there is none.
active_object	Return the active object, raising an error if there is none.
centre	Calculate the weighted centroid of the vectors.
lerp	Linearly interpolate between two values.

Nodes

Helpers for building and manipulating geometry node trees

nodes.new_tree
nodes.swap_tree
nodes.custom_string_iswitch	Creates a node group containing a Index Switch node with all the given values.
nodes.append_from_blend	Append a Geometry Nodes node tree from the given .blend file
nodes.new_socket	Create a new input or output socket on the interface of the node tree.
nodes.tree_interface	Return the interface of a node tree, raising an error if it has none.
nodes.input_socket	Get an input socket of a node by index or name.
nodes.output_socket	Get an output socket of a node by index or name.
nodes.socket_value	Return the default value of a socket.
nodes.set_socket_value	Set the default value of a socket.
nodes.MaintainConnections
nodes.DuplicatePrevention	Context manager to cleanup duplicated node trees when appending node groups