ID(bpy_struct)

base class — bpy_struct

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

class bpy.types.ID(bpy_struct)

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

is_library_indirect

Is this ID block linked indirectly

Type:boolean, default False, (readonly)
is_updated

Datablock is tagged for recalculation

Type:boolean, default False, (readonly)
is_updated_data

Datablock data is tagged for recalculation

Type:boolean, default False, (readonly)
library

Library file the datablock is linked from

Type:Library, (readonly)
name

Unique datablock ID name

Type:string, default “”, (never None)
tag

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

Type:boolean, default False
use_fake_user

Save this datablock even if it has no users

Type:boolean, default False
users

Number of times this datablock is referenced

Type:int in [0, inf], 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()

Clear 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

Inherited Functions

References