Outliner Operators¶
-
bpy.ops.outliner.
action_set
(action='')¶ Change the active action used
Parameters: action (enum in [], (optional)) – Action
-
bpy.ops.outliner.
animdata_operation
(type='CLEAR_ANIMDATA')¶ Undocumented
Parameters: type (enum in ['CLEAR_ANIMDATA', 'SET_ACT', 'CLEAR_ACT', 'REFRESH_DRIVERS', 'CLEAR_DRIVERS'], (optional)) – Animation Operation
CLEAR_ANIMDATA
Clear Animation Data, Remove this animation data container.SET_ACT
Set Action.CLEAR_ACT
Unlink Action.REFRESH_DRIVERS
Refresh Drivers.CLEAR_DRIVERS
Clear Drivers.
-
bpy.ops.outliner.
constraint_operation
(type='ENABLE')¶ Undocumented
Parameters: type (enum in ['ENABLE', 'DISABLE', 'DELETE'], (optional)) – Constraint Operation
-
bpy.ops.outliner.
data_operation
(type='SELECT')¶ Undocumented
Parameters: type (enum in ['SELECT', 'DESELECT', 'HIDE', 'UNHIDE', 'SELECT_LINKED'], (optional)) – Data Operation
-
bpy.ops.outliner.
drivers_add_selected
()¶ Add drivers to selected items
-
bpy.ops.outliner.
drivers_delete_selected
()¶ Delete drivers assigned to selected items
-
bpy.ops.outliner.
expanded_toggle
()¶ Expand/Collapse all items
-
bpy.ops.outliner.
group_link
(object="Object")¶ Link Object to Group in Outliner
Parameters: object (string, (optional, never None)) – Object, Target Object
-
bpy.ops.outliner.
group_operation
(type='UNLINK')¶ Undocumented
Parameters: type (enum in ['UNLINK', 'LOCAL', 'LINK', 'DELETE', 'REMAP', 'INSTANCE', 'TOGVIS', 'TOGSEL', 'TOGREN', 'RENAME'], (optional)) – Group Operation
UNLINK
Unlink Group.LOCAL
Make Local Group.LINK
Link Group Objects to Scene.DELETE
Delete Group, WARNING: no undo.REMAP
Remap Users, Make all users of selected datablocks to use instead current (clicked) one.INSTANCE
Instance Groups in Scene.TOGVIS
Toggle Visible Group.TOGSEL
Toggle Selectable.TOGREN
Toggle Renderable.RENAME
Rename.
-
bpy.ops.outliner.
id_delete
()¶ Delete the ID under cursor
-
bpy.ops.outliner.
id_operation
(type='UNLINK')¶ Undocumented
Parameters: type (enum in ['UNLINK', 'LOCAL', 'SINGLE', 'DELETE', 'REMAP', 'ADD_FAKE', 'CLEAR_FAKE', 'RENAME', 'SELECT_LINKED'], (optional)) – ID data Operation
UNLINK
Unlink.LOCAL
Make Local.SINGLE
Make Single User.DELETE
Delete, WARNING: no undo.REMAP
Remap Users, Make all users of selected datablocks to use instead current (clicked) one.ADD_FAKE
Add Fake User, Ensure datablock gets saved even if it isn’t in use (e.g. for motion and material libraries).CLEAR_FAKE
Clear Fake User.RENAME
Rename.SELECT_LINKED
Select Linked.
-
bpy.ops.outliner.
id_remap
(id_type='OBJECT', old_id='', new_id='')¶ Undocumented
Parameters: - id_type (enum in ['ACTION', 'ARMATURE', 'BRUSH', 'CAMERA', 'CACHEFILE', 'CURVE', 'FONT', 'GREASEPENCIL', 'GROUP', 'IMAGE', 'KEY', 'LAMP', 'LIBRARY', 'LINESTYLE', 'LATTICE', 'MASK', 'MATERIAL', 'META', 'MESH', 'MOVIECLIP', 'NODETREE', 'OBJECT', 'PAINTCURVE', 'PALETTE', 'PARTICLE', 'SCENE', 'SCREEN', 'SOUND', 'SPEAKER', 'TEXT', 'TEXTURE', 'WINDOWMANAGER', 'WORLD'], (optional)) – ID Type
- old_id (enum in [], (optional)) – Old ID, Old ID to replace
- new_id (enum in [], (optional)) – New ID, New ID to remap all selected IDs’ users to
-
bpy.ops.outliner.
item_activate
(extend=True, recursive=False)¶ Handle mouse clicks to activate/select items
Parameters: - extend (boolean, (optional)) – Extend, Extend selection for activation
- recursive (boolean, (optional)) – Recursive, Select Objects and their children
-
bpy.ops.outliner.
item_openclose
(all=True)¶ Toggle whether item under cursor is enabled or closed
Parameters: all (boolean, (optional)) – All, Close or open all items
-
bpy.ops.outliner.
item_rename
()¶ Rename item under cursor
-
bpy.ops.outliner.
keyingset_add_selected
()¶ Add selected items (blue-gray rows) to active Keying Set
-
bpy.ops.outliner.
keyingset_remove_selected
()¶ Remove selected items (blue-gray rows) from active Keying Set
-
bpy.ops.outliner.
lib_operation
(type='RENAME')¶ Undocumented
Parameters: type (enum in ['RENAME', 'DELETE', 'RELOCATE', 'RELOAD'], (optional)) – Library Operation
RENAME
Rename.DELETE
Delete, Delete this library and all its item from Blender - WARNING: no undo.RELOCATE
Relocate, Select a new path for this library, and reload all its data.RELOAD
Reload, Reload all data from this library.
-
bpy.ops.outliner.
lib_relocate
()¶ Relocate the library under cursor
-
bpy.ops.outliner.
material_drop
(object="Object", material="Material")¶ Drag material to object in Outliner
Parameters: - object (string, (optional, never None)) – Object, Target Object
- material (string, (optional, never None)) – Material, Target Material
-
bpy.ops.outliner.
modifier_operation
(type='TOGVIS')¶ Undocumented
Parameters: type (enum in ['TOGVIS', 'TOGREN', 'DELETE'], (optional)) – Modifier Operation
-
bpy.ops.outliner.
object_operation
(type='SELECT')¶ Undocumented
Parameters: type (enum in ['SELECT', 'DESELECT', 'SELECT_HIERARCHY', 'DELETE', 'DELETE_HIERARCHY', 'REMAP', 'TOGVIS', 'TOGSEL', 'TOGREN', 'RENAME'], (optional)) – Object Operation
SELECT
Select.DESELECT
Deselect.SELECT_HIERARCHY
Select Hierarchy.DELETE
Delete.DELETE_HIERARCHY
Delete Hierarchy.REMAP
Remap Users, Make all users of selected datablocks to use instead a new chosen one.TOGVIS
Toggle Visible.TOGSEL
Toggle Selectable.TOGREN
Toggle Renderable.RENAME
Rename.
-
bpy.ops.outliner.
operation
()¶ Context menu for item operations
-
bpy.ops.outliner.
orphans_purge
()¶ Clear all orphaned datablocks without any users from the file (cannot be undone)
-
bpy.ops.outliner.
parent_clear
(dragged_obj="Object", type='CLEAR')¶ Drag to clear parent in Outliner
Parameters: - dragged_obj (string, (optional, never None)) – Child, Child Object
- type (enum in ['CLEAR', 'CLEAR_KEEP_TRANSFORM', 'CLEAR_INVERSE'], (optional)) –
Type
CLEAR
Clear Parent, Completely clear the parenting relationship, including involved modifiers if any.CLEAR_KEEP_TRANSFORM
Clear and Keep Transformation, As ‘Clear Parent’, but keep the current visual transformations of the object.CLEAR_INVERSE
Clear Parent Inverse, Reset the transform corrections applied to the parenting relationship, does not remove parenting itself.
-
bpy.ops.outliner.
parent_drop
(child="Object", parent="Object", type='OBJECT')¶ Drag to parent in Outliner
Parameters: - child (string, (optional, never None)) – Child, Child Object
- parent (string, (optional, never None)) – Parent, Parent Object
- type (enum in ['OBJECT', 'ARMATURE', 'ARMATURE_NAME', 'ARMATURE_AUTO', 'ARMATURE_ENVELOPE', 'BONE', 'BONE_RELATIVE', 'CURVE', 'FOLLOW', 'PATH_CONST', 'LATTICE', 'VERTEX', 'VERTEX_TRI'], (optional)) – Type
-
bpy.ops.outliner.
renderability_toggle
()¶ Toggle the renderability of selected items
-
bpy.ops.outliner.
scene_drop
(object="Object", scene="Scene")¶ Drag object to scene in Outliner
Parameters: - object (string, (optional, never None)) – Object, Target Object
- scene (string, (optional, never None)) – Scene, Target Scene
-
bpy.ops.outliner.
scene_operation
(type='DELETE')¶ Context menu for scene operations
Parameters: type (enum in ['DELETE'], (optional)) – Scene Operation
-
bpy.ops.outliner.
scroll_page
(up=False)¶ Scroll page up or down
Parameters: up (boolean, (optional)) – Up, Scroll up one page
-
bpy.ops.outliner.
select_border
(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0)¶ Use box selection to select tree elements
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
-
bpy.ops.outliner.
selectability_toggle
()¶ Toggle the selectability
-
bpy.ops.outliner.
selected_toggle
()¶ Toggle the Outliner selection of items
-
bpy.ops.outliner.
show_active
()¶ Open up the tree and adjust the view so that the active Object is shown centered
-
bpy.ops.outliner.
show_hierarchy
()¶ Open all object entries and close all others
-
bpy.ops.outliner.
show_one_level
(open=True)¶ Expand/collapse all entries by one level
Parameters: open (boolean, (optional)) – Open, Expand all entries one level deep
-
bpy.ops.outliner.
visibility_toggle
()¶ Toggle the visibility of selected items