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
XAXIS
X-Axis – Left/Right.YAXIS
Y-Axis – Front/Back.ZAXIS
Z-Axis – Top/Bottom.
- 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, never None)) – Name, Name of the newly created bone
- bpy.ops.armature.calculate_roll(type='POS_X', axis_flip=False, axis_only=False)
Automatically fix alignment of select bones’ axes
- Parameters
type (enum in ['POS_X', 'POS_Z', 'GLOBAL_POS_X', 'GLOBAL_POS_Y', 'GLOBAL_POS_Z', 'NEG_X', 'NEG_Z', 'GLOBAL_NEG_X', 'GLOBAL_NEG_Y', 'GLOBAL_NEG_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.dissolve()
Dissolve selected bones from the armature
- bpy.ops.armature.duplicate(do_flip_names=False)
Make copies of the selected bones within the same armature
- Parameters
do_flip_names (boolean, (optional)) – Flip Names, Try to flip names of the bones, if possible, instead of adding a number extension
- bpy.ops.armature.duplicate_move(ARMATURE_OT_duplicate=None, TRANSFORM_OT_translate=None)
Make copies of the selected bones within the same armature and move them
- Parameters
ARMATURE_OT_duplicate (
ARMATURE_OT_duplicate
, (optional)) – Duplicate Selected Bone(s), Make copies of the selected bones within the same armatureTRANSFORM_OT_translate (
TRANSFORM_OT_translate
, (optional)) – Move, Move 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)
Create new bones from the selected joints and move them
- Parameters
ARMATURE_OT_extrude (
ARMATURE_OT_extrude
, (optional)) – Extrude, Create new bones from the selected jointsTRANSFORM_OT_translate (
TRANSFORM_OT_translate
, (optional)) – Move, Move selected items
- bpy.ops.armature.extrude_move(ARMATURE_OT_extrude=None, TRANSFORM_OT_translate=None)
Create new bones from the selected joints and move them
- Parameters
ARMATURE_OT_extrude (
ARMATURE_OT_extrude
, (optional)) – Extrude, Create new bones from the selected jointsTRANSFORM_OT_translate (
TRANSFORM_OT_translate
, (optional)) – Move, Move selected items
- bpy.ops.armature.fill()
Add bone between selected joint(s) and/or 3D cursor
- bpy.ops.armature.flip_names(do_strip_numbers=False)
Flips (and corrects) the axis suffixes of the names of selected bones
- Parameters
do_strip_numbers (boolean, (optional)) – Strip Numbers, Try to remove right-most dot-number from flipped names. Warning: May result in incoherent naming in some cases
- 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.parent_clear(type='CLEAR')
Remove the parent-child relationship between selected bones and their parents
- Parameters
type (enum in ['CLEAR', 'DISCONNECT'], (optional)) – Clear Type, 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)) – Parent Type, Type of parenting
- bpy.ops.armature.reveal(select=True)
Reveal all bones hidden in Edit Mode
- Parameters
select (boolean, (optional)) – Select
- bpy.ops.armature.roll_clear(roll=0.0)
Clear roll for selected bones
- Parameters
roll (float in [-6.28319, 6.28319], (optional)) – Roll
- 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
TOGGLE
Toggle – Toggle selection for all elements.SELECT
Select – Select all elements.DESELECT
Deselect – Deselect all elements.INVERT
Invert – Invert selection of all elements.
- 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)) – Extend, Extend the selection
- bpy.ops.armature.select_less()
Deselect those bones at the boundary of each selection region
- bpy.ops.armature.select_linked(all_forks=False)
Select all bones linked by parent/child connections to the current selection
- Parameters
all_forks (boolean, (optional)) – All Forks, Follow forks in the parents chain
- bpy.ops.armature.select_linked_pick(deselect=False, all_forks=False)
(De)select bones linked by parent/child connections under the mouse cursor
- Parameters
deselect (boolean, (optional)) – Deselect
all_forks (boolean, (optional)) – All Forks, Follow forks in the parents chain
- bpy.ops.armature.select_mirror(only_active=False, extend=False)
Mirror the bone selection
- Parameters
only_active (boolean, (optional)) – Active Only, Only operate on the active bone
extend (boolean, (optional)) – Extend, Extend the selection
- bpy.ops.armature.select_more()
Select those bones connected to the initial selection
- bpy.ops.armature.select_similar(type='LENGTH', threshold=0.1)
Select similar bones by property types
- Parameters
type (enum in ['CHILDREN', 'CHILDREN_IMMEDIATE', 'SIBLINGS', 'LENGTH', 'DIRECTION', 'PREFIX', 'SUFFIX', 'LAYER', 'GROUP', 'SHAPE'], (optional)) – Type
threshold (float in [0, 1], (optional)) – Threshold
- bpy.ops.armature.separate()
Isolate selected bones into a separate armature
- bpy.ops.armature.shortest_path_pick()
Select shortest path between two bones
- bpy.ops.armature.split()
Split off selected bones from connected unselected bones
- bpy.ops.armature.subdivide(number_cuts=1)
Break selected bones into chains of smaller bones
- Parameters
number_cuts (int in [1, 1000], (optional)) – Number of Cuts
- bpy.ops.armature.switch_direction()
Change the direction that a chain of bones points in (head and tail swap)
- bpy.ops.armature.symmetrize(direction='NEGATIVE_X')
Enforce symmetry, make copies of the selection or use existing
- Parameters
direction (enum in ['NEGATIVE_X', 'POSITIVE_X'], (optional)) – Direction, Which sides to copy from and to (when both are selected)