IDOverrideLibrary(bpy_struct)

base class — bpy_struct

class bpy.types.IDOverrideLibrary(bpy_struct)

Struct gathering all data needed by overridden linked IDs

hierarchy_root

Library override ID used as root of the override hierarchy this ID is a member of (readonly)

Type:

ID

is_in_hierarchy

Whether this library override is defined as part of a library hierarchy, or as a single, isolated and autonomous override (default True)

Type:

bool

is_system_override

Whether this library override exists only for the override hierarchy, or if it is actually editable by the user (default False)

Type:

bool

properties

List of overridden properties (default None, readonly)

Type:

IDOverrideLibraryProperties[IDOverrideLibraryProperty]

reference

Linked ID used as reference by this override (readonly)

Type:

ID

operations_update()

Update the library override operations based on the differences between this override ID and its reference

reset(*, do_hierarchy=True, set_system_override=False)

Reset this override to match again its linked reference ID

Parameters:

  • do_hierarchy (bool) – Also reset all the dependencies of this override to match their reference linked IDs (optional)

  • set_system_override (bool) – Reset all user-editable overrides as (non-editable) system overrides (optional)

destroy(*, do_hierarchy=True)

Delete this override ID and remap its usages to its linked reference ID instead

Parameters:

do_hierarchy (bool) – Also delete all the dependencies of this override and remap their usages to their reference linked IDs (optional)

resync(scene, *, view_layer=None, residual_storage=None, do_hierarchy_enforce=False, do_whole_hierarchy=False)

Resync the data-block and its sub-hierarchy, or the whole hierarchy if requested

Parameters:

  • scene (Scene) – The scene to operate in (for contextual things like keeping active object active, ensuring all overridden objects remain instantiated, etc.) (never None)

  • view_layer (ViewLayer) – The view layer to operate in (same usage as the scene data, in case it is not provided the scene’s collection will be used instead) (optional)

  • residual_storage (Collection) – Collection where to store objects that are instantiated in any other collection anymore (garbage collection, will be created if needed and none is provided) (optional)

  • do_hierarchy_enforce (bool) – Enforce restoring the dependency hierarchy between data-blocks to match the one from the reference linked hierarchy (WARNING: if some ID pointers have been purposely overridden, these will be reset to their default value) (optional)

  • do_whole_hierarchy (bool) – Resync the whole hierarchy this data-block belongs to, not only its own sub-hierarchy (optional)

Returns:

Success, Whether the resync process was successful or not

Return type:

bool

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References