BoneCollections(bpy_struct)

base class — bpy_struct

class bpy.types.BoneCollections(bpy_struct)

The Bone Collections of this Armature

active

Armature’s active bone collection

Type:

BoneCollection

active_index

The index of the Armature’s active bone collection; -1 when there is no active collection

Type:

int in [-inf, inf], default 0

active_name

The name of the Armature’s active bone collection; empty when there is no active collection

Type:

string, default “”, (never None)

new(name)

Add a new empty bone collection to the armature

Parameters:

name (string, (never None)) – Name, Name of the new collection. Blender will ensure it is unique within the collections of the Armature

Returns:

Newly created bone collection

Return type:

BoneCollection

remove(bone_collection)

Remove the bone collection from the armature

Parameters:

bone_collection (BoneCollection) – Bone Collection, The bone collection to remove

move(from_index, to_index)

Move a bone collection to a different position in the collection list

Parameters:

  • from_index (int in [-inf, inf]) – From Index, Index to move

  • to_index (int in [-inf, inf]) – To Index, Target index

classmethod bl_rna_get_subclass(id, default=None)
Parameters:

id (string) – 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 (string) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References