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, 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.

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

Previous topic

HookModifier(Modifier)

Next topic

IDMaterials(bpy_struct)