Armature Operators

bpy.ops.armature.align()

Align selected bones to the active bone (or to their parent)

bpy.ops.armature.armature_layers(layers=(False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False))

Change the visible armature layers

Parameters:layers (boolean array of 32 items, (optional)) – Layer, Armature layers to make visible
bpy.ops.armature.autoside_names(type='XAXIS')

Automatically renames the selected bones according to which side of the target axis they fall on

Parameters:type (enum in [‘XAXIS’, ‘YAXIS’, ‘ZAXIS’], (optional)) – Axis, Axis tag names with.
bpy.ops.armature.bone_layers(layers=(False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False))

Change the layers that the selected bones belong to

Parameters:layers (boolean array of 32 items, (optional)) – Layer, Armature layers that bone belongs to
bpy.ops.armature.bone_primitive_add(name="Bone")

Add a new bone located at the 3D-Cursor

Parameters:name (string, (optional)) – Name, Name of the newly created bone
bpy.ops.armature.calculate_roll(type='X', axis_flip=False, axis_only=False)

Automatically fix alignment of select bones’ axes

Parameters:
  • type (enum in [‘X’, ‘Y’, ‘Z’, ‘ACTIVE’, ‘VIEW’, ‘CURSOR’], (optional)) – Type
  • axis_flip (boolean, (optional)) – Flip Axis, Negate the alignment axis.
  • axis_only (boolean, (optional)) – Shortest Rotation, Ignore the axis direction, use the shortest rotation to align.
bpy.ops.armature.click_extrude()

Create a new bone going from the last selected joint to the mouse position

bpy.ops.armature.delete()

Remove selected bones from the armature

bpy.ops.armature.duplicate()

Make copies of the selected bones within the same armature

bpy.ops.armature.duplicate_move(ARMATURE_OT_duplicate=None, TRANSFORM_OT_translate=None)

Undocumented (contribute)

Parameters:
  • ARMATURE_OT_duplicate (ARMATURE_OT_duplicate, (optional)) – Duplicate Selected Bone(s), Make copies of the selected bones within the same armature
  • TRANSFORM_OT_translate (TRANSFORM_OT_translate, (optional)) – Translate, Translate selected items
bpy.ops.armature.extrude(forked=False)

Create new bones from the selected joints

Parameters:forked (boolean, (optional)) – Forked
bpy.ops.armature.extrude_forked(ARMATURE_OT_extrude=None, TRANSFORM_OT_translate=None)

Undocumented (contribute)

Parameters:
  • ARMATURE_OT_extrude (ARMATURE_OT_extrude, (optional)) – Extrude, Create new bones from the selected joints
  • TRANSFORM_OT_translate (TRANSFORM_OT_translate, (optional)) – Translate, Translate selected items
bpy.ops.armature.extrude_move(ARMATURE_OT_extrude=None, TRANSFORM_OT_translate=None)

Undocumented (contribute)

Parameters:
  • ARMATURE_OT_extrude (ARMATURE_OT_extrude, (optional)) – Extrude, Create new bones from the selected joints
  • TRANSFORM_OT_translate (TRANSFORM_OT_translate, (optional)) – Translate, Translate selected items
bpy.ops.armature.fill()

Add bone between selected joint(s) and/or 3D-Cursor

bpy.ops.armature.flags_set(type='DRAWWIRE', mode='CLEAR')

Set flags for armature bones

Parameters:
  • type (enum in [‘DRAWWIRE’, ‘DEFORM’, ‘MULT_VG’, ‘HINGE’, ‘NO_SCALE’, ‘LOCKED’], (optional)) – Type
  • mode (enum in [‘CLEAR’, ‘ENABLE’, ‘TOGGLE’], (optional)) – Mode
bpy.ops.armature.flip_names()

Flips (and corrects) the axis suffixes of the names of selected bones

bpy.ops.armature.hide(unselected=False)

Tag selected bones to not be visible in Edit Mode

Parameters:unselected (boolean, (optional)) – Unselected, Hide unselected rather than selected.
bpy.ops.armature.layers_show_all(all=True)

Make all armature layers visible

Parameters:all (boolean, (optional)) – All Layers, Enable all layers or just the first 16 (top row)
bpy.ops.armature.merge(type='WITHIN_CHAIN')

Merge continuous chains of selected bones

Parameters:type (enum in [‘WITHIN_CHAIN’], (optional)) – Type
bpy.ops.armature.parent_clear(type='CLEAR')

Remove the parent-child relationship between selected bones and their parents

Parameters:type (enum in [‘CLEAR’, ‘DISCONNECT’], (optional)) – ClearType, What way to clear parenting
bpy.ops.armature.parent_set(type='CONNECTED')

Set the active bone as the parent of the selected bones

Parameters:type (enum in [‘CONNECTED’, ‘OFFSET’], (optional)) – ParentType, Type of parenting
bpy.ops.armature.reveal()

Unhide all bones that have been tagged to be hidden in Edit Mode

bpy.ops.armature.select_all(action='TOGGLE')

Toggle selection status of all bones

Parameters:action (enum in [‘TOGGLE’, ‘SELECT’, ‘DESELECT’, ‘INVERT’], (optional)) – Action, Selection action to execute
bpy.ops.armature.select_hierarchy(direction='PARENT', extend=False)

Select immediate parent/children of selected bones

Parameters:
  • direction (enum in [‘PARENT’, ‘CHILD’], (optional)) – Direction
  • extend (boolean, (optional)) – Add to Selection
bpy.ops.armature.select_inverse()

Flip the selection status of bones (selected -> unselected, unselected -> selected)

bpy.ops.armature.select_linked(extend=False)

Select bones related to selected ones by parent/child relationships

Parameters:extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first.
bpy.ops.armature.separate()

Isolate selected bones into a separate armature

bpy.ops.armature.subdivide(number_cuts=1)

Break selected bones into chains of smaller bones

Parameters:number_cuts (int in [1, inf], (optional)) – Number of Cuts
bpy.ops.armature.switch_direction()

Change the direction that a chain of bones points in (head <-> tail swap)

Previous topic

Anim Operators

Next topic

Boid Operators