Anim Operators

bpy.ops.anim.change_frame(frame=0)

Interactively change the current frame number

Parameters:frame (int in [-300000, 300000], (optional)) – Frame

bpy.ops.anim.channels_click(extend=False, children_only=False)

Handle mouse-clicks over animation channels

Parameters:

• extend (boolean, (optional)) – Extend Select
• children_only (boolean, (optional)) – Select Children Only

bpy.ops.anim.channels_collapse(all=True)

Collapse (i.e. close) all selected expandable animation channels

Parameters:all (boolean, (optional)) – All, Collapse all channels (not just selected ones)

bpy.ops.anim.channels_delete()

Delete all selected animation channels

bpy.ops.anim.channels_editable_toggle(mode='TOGGLE', type='PROTECT')

Toggle editability of selected channels

Parameters:

• mode (enum in [‘TOGGLE’, ‘DISABLE’, ‘ENABLE’, ‘INVERT’], (optional)) – Mode
• type (enum in [‘PROTECT’, ‘MUTE’], (optional)) – Type

bpy.ops.anim.channels_expand(all=True)

Expand (i.e. open) all selected expandable animation channels

Parameters:all (boolean, (optional)) – All, Expand all channels (not just selected ones)

bpy.ops.anim.channels_fcurves_enable()

Clears ‘disabled’ tag from all F-Curves to get broken F-Curves working again

bpy.ops.anim.channels_move(direction='DOWN')

Rearrange selected animation channels

Parameters:direction (enum in [‘TOP’, ‘UP’, ‘DOWN’, ‘BOTTOM’], (optional)) – Direction

bpy.ops.anim.channels_rename()

Rename animation channel under mouse

bpy.ops.anim.channels_select_all_toggle(invert=False)

Toggle selection of all animation channels

Parameters:invert (boolean, (optional)) – Invert

bpy.ops.anim.channels_select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0, extend=True)

Select all animation channels within the specified region

Parameters:

• gesture_mode (int in [-inf, inf], (optional)) – Gesture Mode
• xmin (int in [-inf, inf], (optional)) – X Min
• xmax (int in [-inf, inf], (optional)) – X Max
• ymin (int in [-inf, inf], (optional)) – Y Min
• ymax (int in [-inf, inf], (optional)) – Y Max
• extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first

bpy.ops.anim.channels_setting_disable(mode='DISABLE', type='PROTECT')

Disable specified setting on all selected animation channels

Parameters:

• mode (enum in [‘TOGGLE’, ‘DISABLE’, ‘ENABLE’, ‘INVERT’], (optional)) – Mode
• type (enum in [‘PROTECT’, ‘MUTE’], (optional)) – Type

bpy.ops.anim.channels_setting_enable(mode='ENABLE', type='PROTECT')

Enable specified setting on all selected animation channels

Parameters:

• mode (enum in [‘TOGGLE’, ‘DISABLE’, ‘ENABLE’, ‘INVERT’], (optional)) – Mode
• type (enum in [‘PROTECT’, ‘MUTE’], (optional)) – Type

bpy.ops.anim.channels_setting_toggle(mode='TOGGLE', type='PROTECT')

Toggle specified setting on all selected animation channels

Parameters:

• mode (enum in [‘TOGGLE’, ‘DISABLE’, ‘ENABLE’, ‘INVERT’], (optional)) – Mode
• type (enum in [‘PROTECT’, ‘MUTE’], (optional)) – Type

bpy.ops.anim.channels_visibility_set()

Make only the selected animation channels visible in the Graph Editor

bpy.ops.anim.channels_visibility_toggle()

Toggle visibility in Graph Editor of all selected animation channels

bpy.ops.anim.clear_useless_actions(only_unused=True)

Mark actions with no F-Curves for deletion after save+reload of file preserving “action libraries”

Parameters:only_unused (boolean, (optional)) – Only Unused, Only unused (Fake User only) actions get considered File :startup/bl_operators/anim.py:244

bpy.ops.anim.copy_driver_button()

Copy the driver for the highlighted button

bpy.ops.anim.driver_button_add(all=True)

Add driver(s) for the property(s) connected represented by the highlighted button

Parameters:all (boolean, (optional)) – All, Create drivers for all elements of the array

bpy.ops.anim.driver_button_remove(all=True)

Remove the driver(s) for the property(s) connected represented by the highlighted button

Parameters:all (boolean, (optional)) – All, Delete drivers for all elements of the array

bpy.ops.anim.keyframe_delete(type='DEFAULT', confirm_success=True)

Delete keyframes on the current frame for all properties in the specified Keying Set

Parameters:

• type (enum in [‘DEFAULT’], (optional)) – Keying Set, The Keying Set to use
• confirm_success (boolean, (optional)) – Confirm Successful Insert, Show a popup when the keyframes get successfully added

bpy.ops.anim.keyframe_delete_button(all=True)

Undocumented (contribute)

Parameters:all (boolean, (optional)) – All, Delete keyfames from all elements of the array

bpy.ops.anim.keyframe_delete_v3d()

Remove keyframes on current frame for selected object

bpy.ops.anim.keyframe_insert(type='DEFAULT', confirm_success=True)

Insert keyframes on the current frame for all properties in the specified Keying Set

Parameters:

• type (enum in [‘DEFAULT’], (optional)) – Keying Set, The Keying Set to use
• confirm_success (boolean, (optional)) – Confirm Successful Insert, Show a popup when the keyframes get successfully added

bpy.ops.anim.keyframe_insert_button(all=True)

Undocumented (contribute)

Parameters:all (boolean, (optional)) – All, Insert a keyframe for all element of the array

bpy.ops.anim.keyframe_insert_menu(type='DEFAULT', confirm_success=False, always_prompt=False)

Insert Keyframes for specified Keying Set, with menu of available Keying Sets if undefined

Parameters:

• type (enum in [‘DEFAULT’], (optional)) – Keying Set, The Keying Set to use
• confirm_success (boolean, (optional)) – Confirm Successful Insert, Show a popup when the keyframes get successfully added
• always_prompt (boolean, (optional)) – Always Show Menu

bpy.ops.anim.keying_set_active_set(type=0)

Undocumented (contribute)

Parameters:type (int in [-inf, inf], (optional)) – Keying Set Number, Index (determined internally) of the Keying Set to use

bpy.ops.anim.keying_set_add()

Add a new (empty) Keying Set to the active Scene

bpy.ops.anim.keying_set_export(filepath="", filter_folder=True, filter_text=True, filter_python=True)

Export Keying Set to a python script

Parameters:

• filepath (string, (optional)) – filepath
• filter_folder (boolean, (optional)) – Filter folders
• filter_text (boolean, (optional)) – Filter text
• filter_python (boolean, (optional)) – Filter python

File :

startup/bl_operators/anim.py:59

bpy.ops.anim.keying_set_path_add()

Add empty path to active Keying Set

bpy.ops.anim.keying_set_path_remove()

Remove active Path from active Keying Set

bpy.ops.anim.keying_set_remove()

Remove the active Keying Set

bpy.ops.anim.keyingset_button_add(all=True)

Undocumented (contribute)

Parameters:all (boolean, (optional)) – All, Add all elements of the array to a Keying Set

bpy.ops.anim.keyingset_button_remove()

Undocumented (contribute)

bpy.ops.anim.paste_driver_button()

Paste the driver in the copy/paste buffer for the highlighted button

bpy.ops.anim.previewrange_clear()

Clear Preview Range

bpy.ops.anim.previewrange_set(xmin=0, xmax=0, ymin=0, ymax=0)

Interactively define frame range used for playback

Parameters:

• xmin (int in [-inf, inf], (optional)) – X Min
• xmax (int in [-inf, inf], (optional)) – X Max
• ymin (int in [-inf, inf], (optional)) – Y Min
• ymax (int in [-inf, inf], (optional)) – Y Max

bpy.ops.anim.update_data_paths()

Update data paths from 2.56 and previous versions, modifying data paths of drivers and fcurves

File :startup/bl_operators/anim.py:271