BlendDataVolumes(bpy_struct)

base class — bpy_struct

class bpy.types.BlendDataVolumes(bpy_struct)

Collection of volumes

new(name)

Add a new volume to the main database

Parameters:

name (string, (never None)) – New name for the data-block

Returns:

New volume data-block

Return type:

Volume

remove(volume, *, do_unlink=True, do_id_user=True, do_ui_user=True)

Remove a volume from the current blendfile

Parameters:

  • volume (Volume, (never None)) – Volume to remove

  • do_unlink (boolean, (optional)) – Unlink all usages of this volume before deleting it (WARNING: will also delete objects instancing that volume data)

  • do_id_user (boolean, (optional)) – Decrement user counter of all datablocks used by this volume data

  • do_ui_user (boolean, (optional)) – Make sure interface does not reference this volume data

tag(value)

tag

Parameters:

value (boolean) – Value

classmethod bl_rna_get_subclass(id, default=None)
Parameters:

id (str) – The RNA type identifier.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)
Parameters:

id (str) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References