ID(bpy_struct)

base class — bpy_struct

subclasses — Lattice, Library, Key, NodeTree, MetaBall, Text, Lamp, World, Brush, Object, Armature, Mesh, VectorFont, GreasePencil, Sound, ParticleSettings, Scene, WindowManager, Texture, Curve, Action, Group, Screen, Speaker, Material, Image, Camera

class bpy.types.ID(bpy_struct)

Base type for datablocks, defining a unique name, linking from other libraries and garbage collection

library

Library file the datablock is linked from

Type :Library, (readonly)

name

Unique datablock ID name

Type :string, default “”

tag

Tools can use this to tag data, (initial state is undefined)

Type :boolean, default False

use_fake_user

Saves this datablock even if it has no users

Type :boolean, default False

users

Number of times this datablock is referenced

Type :int in [0, 32767], default 0, (readonly)

copy()

Create a copy of this datablock (not supported for all datablocks).

Returns:New copy of the ID. Return type:ID

user_clear()

Clears the user count of a datablock so its not saved, on reload the data will be removed.

This function is for advanced use only, misuse can crash blender since the user count is used to prevent data being removed when it is used.

# This example shows what _not_ to do, and will crash blender.
import bpy

# object which is in the scene.
obj = bpy.data.objects["Cube"]

# without this, removal would raise an error.
obj.user_clear()

# runs without an exception
# but will crash on redraw.
bpy.data.objects.remove(obj)

animation_data_create()

Create animation data to this ID, note that not all ID types support this.

Returns:New animation data or NULL. Return type:AnimData

animation_data_clear()

Clear animation on this this ID.

update_tag(refresh=set())

Tag the id to update its display data.

Parameters:refresh (enum set in {‘OBJECT’, ‘DATA’, ‘TIME’}, (optional)) – Type of updates to perform.

Inherited Properties

bpy_struct.id_data

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set

bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

BlendData.scripts BlendDataObjects.new DopeSheet.source DriverTarget.id ID.copy Key.user KeyingSetPath.id KeyingSetPaths.add

Object.data SpaceNodeEditor.id SpaceNodeEditor.id_from SpaceProperties.pin_id UILayout.template_path_builder UILayout.template_preview UILayout.template_preview