BoneCollection(bpy_struct)

base class — bpy_struct

class bpy.types.BoneCollection(bpy_struct)

Bone collection in an Armature data-block

bones

Bones assigned to this bone collection. In armature edit mode this will always return an empty list of bones, as the bone collection memberships are only synchronised when exiting edit mode

Type:

bpy_prop_collection of Bone, (readonly)

is_visible

Bones in this collection will be visible in pose/object mode

Type:

boolean, default False

name

Unique within the Armature

Type:

string, default “”, (never None)

assign(bone)

Assign the given bone to this collection

Parameters:

bone (AnyType) – Bone to assign to this collection. This must be a Bone, PoseBone, or EditBone

Returns:

Assigned, Whether the bone was actually assigned; will be false if the bone was already member of the collection

Return type:

boolean

unassign(bone)

Remove the given bone from this collection

Parameters:

bone (AnyType) – Bone to remove from this collection. This must be a Bone, PoseBone, or EditBone

Returns:

Unassigned, Whether the bone was actually removed; will be false if the bone was not a member of the collection to begin with

Return type:

boolean

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