Wm Operators

bpy.ops.wm.alembic_export(filepath='', check_existing=True, filter_blender=False, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=True, filter_usd=False, filter_obj=False, filter_volume=False, filter_folder=True, filter_blenlib=False, filemode=8, display_type='DEFAULT', sort_method='', start=- 2147483648, end=- 2147483648, xsamples=1, gsamples=1, sh_open=0.0, sh_close=1.0, selected=False, visible_objects_only=False, flatten=False, uvs=True, packuv=True, normals=True, vcolors=False, orcos=True, face_sets=False, subdiv_schema=False, apply_subdiv=False, curves_as_mesh=False, use_instancing=True, global_scale=1.0, triangulate=False, quad_method='SHORTEST_DIAGONAL', ngon_method='BEAUTY', export_hair=True, export_particles=True, export_custom_properties=True, as_background_job=False, evaluation_mode='RENDER', init_scene_frame_range=True)

Export current scene in an Alembic archive

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • check_existing (boolean, (optional)) – Check Existing, Check and warn on overwriting existing files

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • start (int in [-inf, inf], (optional)) – Start Frame, Start frame of the export, use the default value to take the start frame of the current scene

  • end (int in [-inf, inf], (optional)) – End Frame, End frame of the export, use the default value to take the end frame of the current scene

  • xsamples (int in [1, 128], (optional)) – Transform Samples, Number of times per frame transformations are sampled

  • gsamples (int in [1, 128], (optional)) – Geometry Samples, Number of times per frame object data are sampled

  • sh_open (float in [-1, 1], (optional)) – Shutter Open, Time at which the shutter is open

  • sh_close (float in [-1, 1], (optional)) – Shutter Close, Time at which the shutter is closed

  • selected (boolean, (optional)) – Selected Objects Only, Export only selected objects

  • visible_objects_only (boolean, (optional)) – Visible Objects Only, Export only objects that are visible

  • flatten (boolean, (optional)) – Flatten Hierarchy, Do not preserve objects’ parent/children relationship

  • uvs (boolean, (optional)) – UVs, Export UVs

  • packuv (boolean, (optional)) – Pack UV Islands, Export UVs with packed island

  • normals (boolean, (optional)) – Normals, Export normals

  • vcolors (boolean, (optional)) – Color Attributes, Export color attributes

  • orcos (boolean, (optional)) – Generated Coordinates, Export undeformed mesh vertex coordinates

  • face_sets (boolean, (optional)) – Face Sets, Export per face shading group assignments

  • subdiv_schema (boolean, (optional)) – Use Subdivision Schema, Export meshes using Alembic’s subdivision schema

  • apply_subdiv (boolean, (optional)) – Apply Subdivision Surface, Export subdivision surfaces as meshes

  • curves_as_mesh (boolean, (optional)) – Curves as Mesh, Export curves and NURBS surfaces as meshes

  • use_instancing (boolean, (optional)) – Use Instancing, Export data of duplicated objects as Alembic instances; speeds up the export and can be disabled for compatibility with other software

  • global_scale (float in [0.0001, 1000], (optional)) – Scale, Value by which to enlarge or shrink the objects with respect to the world’s origin

  • triangulate (boolean, (optional)) – Triangulate, Export polygons (quads and n-gons) as triangles

  • quad_method (enum in Modifier Triangulate Quad Method Items, (optional)) – Quad Method, Method for splitting the quads into triangles

  • ngon_method (enum in Modifier Triangulate Ngon Method Items, (optional)) – N-gon Method, Method for splitting the n-gons into triangles

  • export_hair (boolean, (optional)) – Export Hair, Exports hair particle systems as animated curves

  • export_particles (boolean, (optional)) – Export Particles, Exports non-hair particle systems

  • export_custom_properties (boolean, (optional)) – Export Custom Properties, Export custom properties to Alembic .userProperties

  • as_background_job (boolean, (optional)) – Run as Background Job, Enable this to run the import in the background, disable to block Blender while importing. This option is deprecated; EXECUTE this operator to run in the foreground, and INVOKE it to run as a background job

  • evaluation_mode (enum in ['RENDER', 'VIEWPORT'], (optional)) –

    Use Settings for, Determines visibility of objects, modifier settings, and other areas where there are different settings for viewport and rendering

    • RENDER Render – Use Render settings for object visibility, modifier settings, etc.

    • VIEWPORT Viewport – Use Viewport settings for object visibility, modifier settings, etc.

bpy.ops.wm.alembic_import(filepath='', filter_blender=False, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=True, filter_usd=False, filter_obj=False, filter_volume=False, filter_folder=True, filter_blenlib=False, filemode=8, relative_path=True, display_type='DEFAULT', sort_method='', scale=1.0, set_frame_range=True, validate_meshes=False, always_add_cache_reader=False, is_sequence=False, as_background_job=False)

Load an Alembic archive

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • relative_path (boolean, (optional)) – Relative Path, Select the file relative to the blend file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • scale (float in [0.0001, 1000], (optional)) – Scale, Value by which to enlarge or shrink the objects with respect to the world’s origin

  • set_frame_range (boolean, (optional)) – Set Frame Range, If checked, update scene’s start and end frame to match those of the Alembic archive

  • validate_meshes (boolean, (optional)) – Validate Meshes, Check imported mesh objects for invalid data (slow)

  • always_add_cache_reader (boolean, (optional)) – Always Add Cache Reader, Add cache modifiers and constraints to imported objects even if they are not animated so that they can be updated when reloading the Alembic archive

  • is_sequence (boolean, (optional)) – Is Sequence, Set to true if the cache is split into separate files

  • as_background_job (boolean, (optional)) – Run as Background Job, Enable this to run the export in the background, disable to block Blender while exporting. This option is deprecated; EXECUTE this operator to run in the foreground, and INVOKE it to run as a background job

bpy.ops.wm.append(filepath='', directory='', filename='', files=None, filter_blender=True, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_usd=False, filter_obj=False, filter_volume=False, filter_folder=True, filter_blenlib=True, filemode=1, display_type='DEFAULT', sort_method='', link=False, do_reuse_local_id=False, autoselect=True, active_collection=True, instance_collections=False, instance_object_data=True, set_fake=False, use_recursive=True)

Append from a Library .blend file

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • directory (string, (optional, never None)) – Directory, Directory of the file

  • filename (string, (optional, never None)) – File Name, Name of the file

  • files (bpy_prop_collection of OperatorFileListElement, (optional)) – Files

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • link (boolean, (optional)) – Link, Link the objects or data-blocks rather than appending

  • do_reuse_local_id (boolean, (optional)) – Re-Use Local Data, Try to re-use previously matching appended data-blocks instead of appending a new copy

  • autoselect (boolean, (optional)) – Select, Select new objects

  • active_collection (boolean, (optional)) – Active Collection, Put new objects on the active collection

  • instance_collections (boolean, (optional)) – Instance Collections, Create instances for collections, rather than adding them directly to the scene

  • instance_object_data (boolean, (optional)) – Instance Object Data, Create instances for object data which are not referenced by any objects

  • set_fake (boolean, (optional)) – Fake User, Set “Fake User” for appended items (except objects and collections)

  • use_recursive (boolean, (optional)) – Localize All, Localize all appended data, including those indirectly linked from other libraries

bpy.ops.wm.batch_rename(data_type='OBJECT', data_source='SELECT', actions=None)

Rename multiple items at once

Parameters
  • data_type (enum in ['OBJECT', 'COLLECTION', 'MATERIAL', 'MESH', 'CURVE', 'META', 'VOLUME', 'GPENCIL', 'ARMATURE', 'LATTICE', 'LIGHT', 'LIGHT_PROBE', 'CAMERA', 'SPEAKER', 'BONE', 'NODE', 'SEQUENCE_STRIP'], (optional)) – Type, Type of data to rename

  • data_source (enum in ['SELECT', 'ALL'], (optional)) – Source

  • actions (bpy_prop_collection of BatchRenameAction, (optional)) – actions

File

startup/bl_operators/wm.py:2943

bpy.ops.wm.blend_strings_utf8_validate()

Check and fix all strings in current .blend file to be valid UTF-8 Unicode (needed for some old, 2.4x area files)

File

startup/bl_operators/file.py:287

bpy.ops.wm.call_menu(name='')

Open a predefined menu

Parameters

name (string, (optional, never None)) – Name, Name of the menu

bpy.ops.wm.call_menu_pie(name='')

Open a predefined pie menu

Parameters

name (string, (optional, never None)) – Name, Name of the pie menu

bpy.ops.wm.call_panel(name='', keep_open=True)

Open a predefined panel

Parameters
  • name (string, (optional, never None)) – Name, Name of the menu

  • keep_open (boolean, (optional)) – Keep Open

bpy.ops.wm.collada_export(filepath='', check_existing=True, filter_blender=False, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=True, filter_alembic=False, filter_usd=False, filter_obj=False, filter_volume=False, filter_folder=True, filter_blenlib=False, filemode=8, display_type='DEFAULT', sort_method='', prop_bc_export_ui_section='main', apply_modifiers=False, export_mesh_type=0, export_mesh_type_selection='view', export_global_forward_selection='Y', export_global_up_selection='Z', apply_global_orientation=False, selected=False, include_children=False, include_armatures=False, include_shapekeys=False, deform_bones_only=False, include_animations=True, include_all_actions=True, export_animation_type_selection='sample', sampling_rate=1, keep_smooth_curves=False, keep_keyframes=False, keep_flat_curves=False, active_uv_only=False, use_texture_copies=True, triangulate=True, use_object_instantiation=True, use_blender_profile=True, sort_by_name=False, export_object_transformation_type=0, export_object_transformation_type_selection='matrix', export_animation_transformation_type=0, export_animation_transformation_type_selection='matrix', open_sim=False, limit_precision=False, keep_bind_info=False)

Save a Collada file

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • check_existing (boolean, (optional)) – Check Existing, Check and warn on overwriting existing files

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • prop_bc_export_ui_section (enum in ['main', 'geometry', 'armature', 'animation', 'collada'], (optional)) –

    Export Section, Only for User Interface organization

    • main Main – Data export section.

    • geometry Geom – Geometry export section.

    • armature Arm – Armature export section.

    • animation Anim – Animation export section.

    • collada Extra – Collada export section.

  • apply_modifiers (boolean, (optional)) – Apply Modifiers, Apply modifiers to exported mesh (non destructive))

  • export_mesh_type (int in [-inf, inf], (optional)) – Resolution, Modifier resolution for export

  • export_mesh_type_selection (enum in ['view', 'render'], (optional)) –

    Resolution, Modifier resolution for export

    • view Viewport – Apply modifier’s viewport settings.

    • render Render – Apply modifier’s render settings.

  • export_global_forward_selection (enum in ['X', 'Y', 'Z', '-X', '-Y', '-Z'], (optional)) –

    Global Forward Axis, Global Forward axis for export

    • X X – Global Forward is positive X Axis.

    • Y Y – Global Forward is positive Y Axis.

    • Z Z – Global Forward is positive Z Axis.

    • -X -X – Global Forward is negative X Axis.

    • -Y -Y – Global Forward is negative Y Axis.

    • -Z -Z – Global Forward is negative Z Axis.

  • export_global_up_selection (enum in ['X', 'Y', 'Z', '-X', '-Y', '-Z'], (optional)) –

    Global Up Axis, Global Up axis for export

    • X X – Global UP is positive X Axis.

    • Y Y – Global UP is positive Y Axis.

    • Z Z – Global UP is positive Z Axis.

    • -X -X – Global UP is negative X Axis.

    • -Y -Y – Global UP is negative Y Axis.

    • -Z -Z – Global UP is negative Z Axis.

  • apply_global_orientation (boolean, (optional)) – Apply Global Orientation, Rotate all root objects to match the global orientation settings otherwise set the global orientation per Collada asset

  • selected (boolean, (optional)) – Selection Only, Export only selected elements

  • include_children (boolean, (optional)) – Include Children, Export all children of selected objects (even if not selected)

  • include_armatures (boolean, (optional)) – Include Armatures, Export related armatures (even if not selected)

  • include_shapekeys (boolean, (optional)) – Include Shape Keys, Export all Shape Keys from Mesh Objects

  • deform_bones_only (boolean, (optional)) – Deform Bones Only, Only export deforming bones with armatures

  • include_animations (boolean, (optional)) – Include Animations, Export animations if available (exporting animations will enforce the decomposition of node transforms into <translation> <rotation> and <scale> components)

  • include_all_actions (boolean, (optional)) – Include all Actions, Export also unassigned actions (this allows you to export entire animation libraries for your character(s))

  • export_animation_type_selection (enum in ['sample', 'keys'], (optional)) –

    Key Type, Type for exported animations (use sample keys or Curve keys)

    • sample Samples – Export Sampled points guided by sampling rate.

    • keys Curves – Export Curves (note: guided by curve keys).

  • sampling_rate (int in [1, inf], (optional)) – Sampling Rate, The distance between 2 keyframes (1 to key every frame)

  • keep_smooth_curves (boolean, (optional)) – Keep Smooth curves, Export also the curve handles (if available) (this does only work when the inverse parent matrix is the unity matrix, otherwise you may end up with odd results)

  • keep_keyframes (boolean, (optional)) – Keep Keyframes, Use existing keyframes as additional sample points (this helps when you want to keep manual tweaks)

  • keep_flat_curves (boolean, (optional)) – All Keyed Curves, Export also curves which have only one key or are totally flat

  • active_uv_only (boolean, (optional)) – Only Selected UV Map, Export only the selected UV Map

  • use_texture_copies (boolean, (optional)) – Copy, Copy textures to same folder where the .dae file is exported

  • triangulate (boolean, (optional)) – Triangulate, Export polygons (quads and n-gons) as triangles

  • use_object_instantiation (boolean, (optional)) – Use Object Instances, Instantiate multiple Objects from same Data

  • use_blender_profile (boolean, (optional)) – Use Blender Profile, Export additional Blender specific information (for material, shaders, bones, etc.)

  • sort_by_name (boolean, (optional)) – Sort by Object name, Sort exported data by Object name

  • export_object_transformation_type (int in [-inf, inf], (optional)) – Transform, Object Transformation type for translation, scale and rotation

  • export_object_transformation_type_selection (enum in ['matrix', 'decomposed'], (optional)) –

    Transform, Object Transformation type for translation, scale and rotation

    • matrix Matrix – Use <matrix> representation for exported transformations.

    • decomposed Decomposed – Use <rotate>, <translate> and <scale> representation for exported transformations.

  • export_animation_transformation_type (int in [-inf, inf], (optional)) – Transform, Transformation type for translation, scale and rotation. Note: The Animation transformation type in the Anim Tab is always equal to the Object transformation type in the Geom tab

  • export_animation_transformation_type_selection (enum in ['matrix', 'decomposed'], (optional)) –

    Transform, Transformation type for translation, scale and rotation. Note: The Animation transformation type in the Anim Tab is always equal to the Object transformation type in the Geom tab

    • matrix Matrix – Use <matrix> representation for exported transformations.

    • decomposed Decomposed – Use <rotate>, <translate> and <scale> representation for exported transformations.

  • open_sim (boolean, (optional)) – Export to SL/OpenSim, Compatibility mode for SL, OpenSim and other compatible online worlds

  • limit_precision (boolean, (optional)) – Limit Precision, Reduce the precision of the exported data to 6 digits

  • keep_bind_info (boolean, (optional)) – Keep Bind Info, Store Bindpose information in custom bone properties for later use during Collada export

bpy.ops.wm.collada_import(filepath='', filter_blender=False, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=True, filter_alembic=False, filter_usd=False, filter_obj=False, filter_volume=False, filter_folder=True, filter_blenlib=False, filemode=8, display_type='DEFAULT', sort_method='', import_units=False, fix_orientation=False, find_chains=False, auto_connect=False, min_chain_length=0, keep_bind_info=False)

Load a Collada file

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • import_units (boolean, (optional)) – Import Units, If disabled match import to Blender’s current Unit settings, otherwise use the settings from the Imported scene

  • fix_orientation (boolean, (optional)) – Fix Leaf Bones, Fix Orientation of Leaf Bones (Collada does only support Joints)

  • find_chains (boolean, (optional)) – Find Bone Chains, Find best matching Bone Chains and ensure bones in chain are connected

  • auto_connect (boolean, (optional)) – Auto Connect, Set use_connect for parent bones which have exactly one child bone

  • min_chain_length (int in [0, inf], (optional)) – Minimum Chain Length, When searching Bone Chains disregard chains of length below this value

  • keep_bind_info (boolean, (optional)) – Keep Bind Info, Store Bindpose information in custom bone properties for later use during Collada export

bpy.ops.wm.context_collection_boolean_set(data_path_iter='', data_path_item='', type='TOGGLE')

Set boolean values for a collection of items

Parameters
  • data_path_iter (string, (optional, never None)) – data_path_iter, The data path relative to the context, must point to an iterable

  • data_path_item (string, (optional, never None)) – data_path_item, The data path from each iterable to the value (int or float)

  • type (enum in ['TOGGLE', 'ENABLE', 'DISABLE'], (optional)) – Type

File

startup/bl_operators/wm.py:853

bpy.ops.wm.context_cycle_array(data_path='', reverse=False)

Set a context array value (useful for cycling the active mesh edit mode)

Parameters
  • data_path (string, (optional, never None)) – Context Attributes, Context data-path (expanded using visible windows in the current .blend file)

  • reverse (boolean, (optional)) – Reverse, Cycle backwards

File

startup/bl_operators/wm.py:656

bpy.ops.wm.context_cycle_enum(data_path='', reverse=False, wrap=False)

Toggle a context value

Parameters
  • data_path (string, (optional, never None)) – Context Attributes, Context data-path (expanded using visible windows in the current .blend file)

  • reverse (boolean, (optional)) – Reverse, Cycle backwards

  • wrap (boolean, (optional)) – Wrap, Wrap back to the first/last values

File

startup/bl_operators/wm.py:607

bpy.ops.wm.context_cycle_int(data_path='', reverse=False, wrap=False)

Set a context value (useful for cycling active material, vertex keys, groups, etc.)

Parameters
  • data_path (string, (optional, never None)) – Context Attributes, Context data-path (expanded using visible windows in the current .blend file)

  • reverse (boolean, (optional)) – Reverse, Cycle backwards

  • wrap (boolean, (optional)) – Wrap, Wrap back to the first/last values

File

startup/bl_operators/wm.py:567

bpy.ops.wm.context_menu_enum(data_path='')

Undocumented, consider contributing.

Parameters

data_path (string, (optional, never None)) – Context Attributes, Context data-path (expanded using visible windows in the current .blend file)

File

startup/bl_operators/wm.py:685

bpy.ops.wm.context_modal_mouse(data_path_iter='', data_path_item='', header_text='', input_scale=0.01, invert=False, initial_x=0)

Adjust arbitrary values with mouse input

Parameters
  • data_path_iter (string, (optional, never None)) – data_path_iter, The data path relative to the context, must point to an iterable

  • data_path_item (string, (optional, never None)) – data_path_item, The data path from each iterable to the value (int or float)

  • header_text (string, (optional, never None)) – Header Text, Text to display in header during scale

  • input_scale (float in [-inf, inf], (optional)) – input_scale, Scale the mouse movement by this value before applying the delta

  • invert (boolean, (optional)) – invert, Invert the mouse input

  • initial_x (int in [-inf, inf], (optional)) – initial_x

File

startup/bl_operators/wm.py:990

bpy.ops.wm.context_pie_enum(data_path='')

Undocumented, consider contributing.

Parameters

data_path (string, (optional, never None)) – Context Attributes, Context data-path (expanded using visible windows in the current .blend file)

File

startup/bl_operators/wm.py:716

bpy.ops.wm.context_scale_float(data_path='', value=1.0)

Scale a float context value

Parameters
  • data_path (string, (optional, never None)) – Context Attributes, Context data-path (expanded using visible windows in the current .blend file)

  • value (float in [-inf, inf], (optional)) – Value, Assign value

File

startup/bl_operators/wm.py:326

bpy.ops.wm.context_scale_int(data_path='', value=1.0, always_step=True)

Scale an int context value

Parameters
  • data_path (string, (optional, never None)) – Context Attributes, Context data-path (expanded using visible windows in the current .blend file)

  • value (float in [-inf, inf], (optional)) – Value, Assign value

  • always_step (boolean, (optional)) – Always Step, Always adjust the value by a minimum of 1 when ‘value’ is not 1.0

File

startup/bl_operators/wm.py:364

bpy.ops.wm.context_set_boolean(data_path='', value=True)

Set a context value

Parameters
  • data_path (string, (optional, never None)) – Context Attributes, Context data-path (expanded using visible windows in the current .blend file)

  • value (boolean, (optional)) – Value, Assignment value

File

startup/bl_operators/wm.py:255

bpy.ops.wm.context_set_enum(data_path='', value='')

Set a context value

Parameters
  • data_path (string, (optional, never None)) – Context Attributes, Context data-path (expanded using visible windows in the current .blend file)

  • value (string, (optional, never None)) – Value, Assignment value (as a string)

File

startup/bl_operators/wm.py:255

bpy.ops.wm.context_set_float(data_path='', value=0.0, relative=False)

Set a context value

Parameters
  • data_path (string, (optional, never None)) – Context Attributes, Context data-path (expanded using visible windows in the current .blend file)

  • value (float in [-inf, inf], (optional)) – Value, Assignment value

  • relative (boolean, (optional)) – Relative, Apply relative to the current value (delta)

File

startup/bl_operators/wm.py:255

bpy.ops.wm.context_set_id(data_path='', value='')

Set a context value to an ID data-block

Parameters
  • data_path (string, (optional, never None)) – Context Attributes, Context data-path (expanded using visible windows in the current .blend file)

  • value (string, (optional, never None)) – Value, Assign value

File

startup/bl_operators/wm.py:797

bpy.ops.wm.context_set_int(data_path='', value=0, relative=False)

Set a context value

Parameters
  • data_path (string, (optional, never None)) – Context Attributes, Context data-path (expanded using visible windows in the current .blend file)

  • value (int in [-inf, inf], (optional)) – Value, Assign value

  • relative (boolean, (optional)) – Relative, Apply relative to the current value (delta)

File

startup/bl_operators/wm.py:255

bpy.ops.wm.context_set_string(data_path='', value='')

Set a context value

Parameters
  • data_path (string, (optional, never None)) – Context Attributes, Context data-path (expanded using visible windows in the current .blend file)

  • value (string, (optional, never None)) – Value, Assign value

File

startup/bl_operators/wm.py:255

bpy.ops.wm.context_set_value(data_path='', value='')

Set a context value

Parameters
  • data_path (string, (optional, never None)) – Context Attributes, Context data-path (expanded using visible windows in the current .blend file)

  • value (string, (optional, never None)) – Value, Assignment value (as a string)

File

startup/bl_operators/wm.py:467

bpy.ops.wm.context_toggle(data_path='', module='')

Toggle a context value

Parameters
  • data_path (string, (optional, never None)) – Context Attributes, Context data-path (expanded using visible windows in the current .blend file)

  • module (string, (optional, never None)) – Module, Optionally override the context with a module

File

startup/bl_operators/wm.py:491

bpy.ops.wm.context_toggle_enum(data_path='', value_1='', value_2='')

Toggle a context value

Parameters
  • data_path (string, (optional, never None)) – Context Attributes, Context data-path (expanded using visible windows in the current .blend file)

  • value_1 (string, (optional, never None)) – Value, Toggle enum

  • value_2 (string, (optional, never None)) – Value, Toggle enum

File

startup/bl_operators/wm.py:532

bpy.ops.wm.debug_menu(debug_value=0)

Open a popup to set the debug level

Parameters

debug_value (int in [-32768, 32767], (optional)) – Debug Value

bpy.ops.wm.doc_view(doc_id='')

Open online reference docs in a web browser

Parameters

doc_id (string, (optional, never None)) – Doc ID

File

startup/bl_operators/wm.py:1294

bpy.ops.wm.doc_view_manual(doc_id='')

Load online manual

Parameters

doc_id (string, (optional, never None)) – Doc ID

File

startup/bl_operators/wm.py:1264

bpy.ops.wm.doc_view_manual_ui_context()

View a context based online manual in a web browser

bpy.ops.wm.drop_blend_file(filepath='')

Undocumented, consider contributing.

Parameters

filepath (string, (optional, never None)) – filepath

File

startup/bl_operators/wm.py:3156

bpy.ops.wm.gpencil_export_pdf(filepath='', check_existing=True, filter_blender=False, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_usd=False, filter_obj=True, filter_volume=False, filter_folder=True, filter_blenlib=False, filemode=8, display_type='DEFAULT', sort_method='', use_fill=True, selected_object_type='SELECTED', stroke_sample=0.0, use_normalized_thickness=False, frame_mode='ACTIVE')

Export grease pencil to PDF

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • check_existing (boolean, (optional)) – Check Existing, Check and warn on overwriting existing files

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • use_fill (boolean, (optional)) – Fill, Export strokes with fill enabled

  • selected_object_type (enum in ['ACTIVE', 'SELECTED', 'VISIBLE'], (optional)) –

    Object, Which objects to include in the export

    • ACTIVE Active – Include only the active object.

    • SELECTED Selected – Include selected objects.

    • VISIBLE Visible – Include all visible objects.

  • stroke_sample (float in [0, 100], (optional)) – Sampling, Precision of stroke sampling. Low values mean a more precise result, and zero disables sampling

  • use_normalized_thickness (boolean, (optional)) – Normalize, Export strokes with constant thickness

  • frame_mode (enum in ['ACTIVE', 'SELECTED', 'SCENE'], (optional)) –

    Frames, Which frames to include in the export

    • ACTIVE Active – Include only active frame.

    • SELECTED Selected – Include selected frames.

    • SCENE Scene – Include all scene frames.

bpy.ops.wm.gpencil_export_svg(filepath='', check_existing=True, filter_blender=False, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_usd=False, filter_obj=True, filter_volume=False, filter_folder=True, filter_blenlib=False, filemode=8, display_type='DEFAULT', sort_method='', use_fill=True, selected_object_type='SELECTED', stroke_sample=0.0, use_normalized_thickness=False, use_clip_camera=False)

Export grease pencil to SVG

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • check_existing (boolean, (optional)) – Check Existing, Check and warn on overwriting existing files

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • use_fill (boolean, (optional)) – Fill, Export strokes with fill enabled

  • selected_object_type (enum in ['ACTIVE', 'SELECTED', 'VISIBLE'], (optional)) –

    Object, Which objects to include in the export

    • ACTIVE Active – Include only the active object.

    • SELECTED Selected – Include selected objects.

    • VISIBLE Visible – Include all visible objects.

  • stroke_sample (float in [0, 100], (optional)) – Sampling, Precision of stroke sampling. Low values mean a more precise result, and zero disables sampling

  • use_normalized_thickness (boolean, (optional)) – Normalize, Export strokes with constant thickness

  • use_clip_camera (boolean, (optional)) – Clip Camera, Clip drawings to camera size when export in camera view

bpy.ops.wm.gpencil_import_svg(filepath='', filter_blender=False, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_usd=False, filter_obj=True, filter_volume=False, filter_folder=False, filter_blenlib=False, filemode=8, relative_path=True, display_type='DEFAULT', sort_method='', resolution=10, scale=10.0)

Import SVG into grease pencil

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • relative_path (boolean, (optional)) – Relative Path, Select the file relative to the blend file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • resolution (int in [1, 30], (optional)) – Resolution, Resolution of the generated strokes

  • scale (float in [0.001, 100], (optional)) – Scale, Scale of the final strokes

bpy.ops.wm.interface_theme_preset_add(name='', remove_name=False, remove_active=False)

Add or remove a theme preset

Parameters
  • name (string, (optional, never None)) – Name, Name of the preset, used to make the path name

  • remove_name (boolean, (optional)) – remove_name

  • remove_active (boolean, (optional)) – remove_active

File

startup/bl_operators/presets.py:68

bpy.ops.wm.keyconfig_preset_add(name='', remove_name=False, remove_active=False)

Add or remove a Key-config Preset

Parameters
  • name (string, (optional, never None)) – Name, Name of the preset, used to make the path name

  • remove_name (boolean, (optional)) – remove_name

  • remove_active (boolean, (optional)) – remove_active

File

startup/bl_operators/presets.py:68

bpy.ops.wm.lib_reload(library='', filepath='', directory='', filename='', hide_props_region=True, filter_blender=True, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_usd=False, filter_obj=False, filter_volume=False, filter_folder=True, filter_blenlib=False, filemode=8, relative_path=True, display_type='DEFAULT', sort_method='')

Reload the given library

Parameters
  • library (string, (optional, never None)) – Library, Library to reload

  • filepath (string, (optional, never None)) – File Path, Path to file

  • directory (string, (optional, never None)) – Directory, Directory of the file

  • filename (string, (optional, never None)) – File Name, Name of the file

  • hide_props_region (boolean, (optional)) – Hide Operator Properties, Collapse the region displaying the operator settings

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • relative_path (boolean, (optional)) – Relative Path, Select the file relative to the blend file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

bpy.ops.wm.lib_relocate(library='', filepath='', directory='', filename='', files=None, hide_props_region=True, filter_blender=True, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_usd=False, filter_obj=False, filter_volume=False, filter_folder=True, filter_blenlib=False, filemode=8, relative_path=True, display_type='DEFAULT', sort_method='')

Relocate the given library to one or several others

Parameters
  • library (string, (optional, never None)) – Library, Library to relocate

  • filepath (string, (optional, never None)) – File Path, Path to file

  • directory (string, (optional, never None)) – Directory, Directory of the file

  • filename (string, (optional, never None)) – File Name, Name of the file

  • files (bpy_prop_collection of OperatorFileListElement, (optional)) – Files

  • hide_props_region (boolean, (optional)) – Hide Operator Properties, Collapse the region displaying the operator settings

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • relative_path (boolean, (optional)) – Relative Path, Select the file relative to the blend file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

Link from a Library .blend file

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • directory (string, (optional, never None)) – Directory, Directory of the file

  • filename (string, (optional, never None)) – File Name, Name of the file

  • files (bpy_prop_collection of OperatorFileListElement, (optional)) – Files

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • relative_path (boolean, (optional)) – Relative Path, Select the file relative to the blend file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • link (boolean, (optional)) – Link, Link the objects or data-blocks rather than appending

  • do_reuse_local_id (boolean, (optional)) – Re-Use Local Data, Try to re-use previously matching appended data-blocks instead of appending a new copy

  • autoselect (boolean, (optional)) – Select, Select new objects

  • active_collection (boolean, (optional)) – Active Collection, Put new objects on the active collection

  • instance_collections (boolean, (optional)) – Instance Collections, Create instances for collections, rather than adding them directly to the scene

  • instance_object_data (boolean, (optional)) – Instance Object Data, Create instances for object data which are not referenced by any objects

bpy.ops.wm.memory_statistics()

Print memory statistics to the console

bpy.ops.wm.obj_export(filepath='', check_existing=True, filter_blender=False, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_usd=False, filter_obj=False, filter_volume=False, filter_folder=True, filter_blenlib=False, filemode=8, display_type='DEFAULT', sort_method='', export_animation=False, start_frame=- 2147483648, end_frame=2147483647, forward_axis='NEGATIVE_Z', up_axis='Y', scaling_factor=1.0, apply_modifiers=True, export_eval_mode='DAG_EVAL_VIEWPORT', export_selected_objects=False, export_uv=True, export_normals=True, export_colors=False, export_materials=True, path_mode='AUTO', export_triangulated_mesh=False, export_curves_as_nurbs=False, export_object_groups=False, export_material_groups=False, export_vertex_groups=False, export_smooth_groups=False, smooth_group_bitflags=False, filter_glob='*.obj;*.mtl')

Save the scene to a Wavefront OBJ file

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • check_existing (boolean, (optional)) – Check Existing, Check and warn on overwriting existing files

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • export_animation (boolean, (optional)) – Export Animation, Export multiple frames instead of the current frame only

  • start_frame (int in [-inf, inf], (optional)) – Start Frame, The first frame to be exported

  • end_frame (int in [-inf, inf], (optional)) – End Frame, The last frame to be exported

  • forward_axis (enum in ['X', 'Y', 'Z', 'NEGATIVE_X', 'NEGATIVE_Y', 'NEGATIVE_Z'], (optional)) –

    Forward Axis

    • X X – Positive X axis.

    • Y Y – Positive Y axis.

    • Z Z – Positive Z axis.

    • NEGATIVE_X -X – Negative X axis.

    • NEGATIVE_Y -Y – Negative Y axis.

    • NEGATIVE_Z -Z – Negative Z axis.

  • up_axis (enum in ['X', 'Y', 'Z', 'NEGATIVE_X', 'NEGATIVE_Y', 'NEGATIVE_Z'], (optional)) –

    Up Axis

    • X X – Positive X axis.

    • Y Y – Positive Y axis.

    • Z Z – Positive Z axis.

    • NEGATIVE_X -X – Negative X axis.

    • NEGATIVE_Y -Y – Negative Y axis.

    • NEGATIVE_Z -Z – Negative Z axis.

  • scaling_factor (float in [0.001, 10000], (optional)) – Scale, Upscale the object by this factor

  • apply_modifiers (boolean, (optional)) – Apply Modifiers, Apply modifiers to exported meshes

  • export_eval_mode (enum in ['DAG_EVAL_RENDER', 'DAG_EVAL_VIEWPORT'], (optional)) –

    Object Properties, Determines properties like object visibility, modifiers etc., where they differ for Render and Viewport

    • DAG_EVAL_RENDER Render – Export objects as they appear in render.

    • DAG_EVAL_VIEWPORT Viewport – Export objects as they appear in the viewport.

  • export_selected_objects (boolean, (optional)) – Export Selected Objects, Export only selected objects instead of all supported objects

  • export_uv (boolean, (optional)) – Export UVs

  • export_normals (boolean, (optional)) – Export Normals, Export per-face normals if the face is flat-shaded, per-face-per-loop normals if smooth-shaded

  • export_colors (boolean, (optional)) – Export Colors, Export per-vertex colors

  • export_materials (boolean, (optional)) – Export Materials, Export MTL library. There must be a Principled-BSDF node for image textures to be exported to the MTL file

  • path_mode (enum in ['AUTO', 'ABSOLUTE', 'RELATIVE', 'MATCH', 'STRIP', 'COPY'], (optional)) –

    Path Mode, Method used to reference paths

    • AUTO Auto – Use Relative paths with subdirectories only.

    • ABSOLUTE Absolute – Always write absolute paths.

    • RELATIVE Relative – Write relative paths where possible.

    • MATCH Match – Match Absolute/Relative setting with input path.

    • STRIP Strip – Write filename only.

    • COPY Copy – Copy the file to the destination path.

  • export_triangulated_mesh (boolean, (optional)) – Export Triangulated Mesh, All ngons with four or more vertices will be triangulated. Meshes in the scene will not be affected. Behaves like Triangulate Modifier with ngon-method: “Beauty”, quad-method: “Shortest Diagonal”, min vertices: 4

  • export_curves_as_nurbs (boolean, (optional)) – Export Curves as NURBS, Export curves in parametric form instead of exporting as mesh

  • export_object_groups (boolean, (optional)) – Export Object Groups, Append mesh name to object name, separated by a ‘_’

  • export_material_groups (boolean, (optional)) – Export Material Groups, Generate an OBJ group for each part of a geometry using a different material

  • export_vertex_groups (boolean, (optional)) – Export Vertex Groups, Export the name of the vertex group of a face. It is approximated by choosing the vertex group with the most members among the vertices of a face

  • export_smooth_groups (boolean, (optional)) – Export Smooth Groups, Every smooth-shaded face is assigned group “1” and every flat-shaded face “off”

  • smooth_group_bitflags (boolean, (optional)) – Generate Bitflags for Smooth Groups

  • filter_glob (string, (optional, never None)) – Extension Filter

bpy.ops.wm.obj_import(filepath='', filter_blender=False, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_usd=False, filter_obj=False, filter_volume=False, filter_folder=True, filter_blenlib=False, filemode=8, display_type='DEFAULT', sort_method='', clamp_size=0.0, forward_axis='NEGATIVE_Z', up_axis='Y', import_vertex_groups=False, validate_meshes=False, filter_glob='*.obj;*.mtl')

Load a Wavefront OBJ scene

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • clamp_size (float in [0, 1000], (optional)) – Clamp Bounding Box, Resize the objects to keep bounding box under this value. Value 0 disables clamping

  • forward_axis (enum in ['X', 'Y', 'Z', 'NEGATIVE_X', 'NEGATIVE_Y', 'NEGATIVE_Z'], (optional)) –

    Forward Axis

    • X X – Positive X axis.

    • Y Y – Positive Y axis.

    • Z Z – Positive Z axis.

    • NEGATIVE_X -X – Negative X axis.

    • NEGATIVE_Y -Y – Negative Y axis.

    • NEGATIVE_Z -Z – Negative Z axis.

  • up_axis (enum in ['X', 'Y', 'Z', 'NEGATIVE_X', 'NEGATIVE_Y', 'NEGATIVE_Z'], (optional)) –

    Up Axis

    • X X – Positive X axis.

    • Y Y – Positive Y axis.

    • Z Z – Positive Z axis.

    • NEGATIVE_X -X – Negative X axis.

    • NEGATIVE_Y -Y – Negative Y axis.

    • NEGATIVE_Z -Z – Negative Z axis.

  • import_vertex_groups (boolean, (optional)) – Vertex Groups, Import OBJ groups as vertex groups

  • validate_meshes (boolean, (optional)) – Validate Meshes, Check imported mesh objects for invalid data (slow)

  • filter_glob (string, (optional, never None)) – Extension Filter

bpy.ops.wm.open_mainfile(filepath='', hide_props_region=True, filter_blender=True, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_usd=False, filter_obj=False, filter_volume=False, filter_folder=True, filter_blenlib=False, filemode=8, display_type='DEFAULT', sort_method='', load_ui=True, use_scripts=True, display_file_selector=True, state=0)

Open a Blender file

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • hide_props_region (boolean, (optional)) – Hide Operator Properties, Collapse the region displaying the operator settings

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • load_ui (boolean, (optional)) – Load UI, Load user interface setup in the .blend file

  • use_scripts (boolean, (optional)) – Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences

  • display_file_selector (boolean, (optional)) – Display File Selector

  • state (int in [-inf, inf], (optional)) – State

bpy.ops.wm.operator_cheat_sheet()

List all the operators in a text-block, useful for scripting

File

startup/bl_operators/wm.py:2058

bpy.ops.wm.operator_defaults()

Set the active operator to its default values

bpy.ops.wm.operator_pie_enum(data_path='', prop_string='')

Undocumented, consider contributing.

Parameters
  • data_path (string, (optional, never None)) – Operator, Operator name (in python as string)

  • prop_string (string, (optional, never None)) – Property, Property name (as a string)

File

startup/bl_operators/wm.py:757

bpy.ops.wm.operator_preset_add(name='', remove_name=False, remove_active=False, operator='')

Add or remove an Operator Preset

Parameters
  • name (string, (optional, never None)) – Name, Name of the preset, used to make the path name

  • remove_name (boolean, (optional)) – remove_name

  • remove_active (boolean, (optional)) – remove_active

  • operator (string, (optional, never None)) – Operator

File

startup/bl_operators/presets.py:68

bpy.ops.wm.owner_disable(owner_id='')

Enable workspace owner ID

Parameters

owner_id (string, (optional, never None)) – UI Tag

File

startup/bl_operators/wm.py:2106

bpy.ops.wm.owner_enable(owner_id='')

Enable workspace owner ID

Parameters

owner_id (string, (optional, never None)) – UI Tag

File

startup/bl_operators/wm.py:2091

bpy.ops.wm.path_open(filepath='')

Open a path in a file browser

Parameters

filepath (string, (optional, never None)) – filepath

File

startup/bl_operators/wm.py:1117

bpy.ops.wm.previews_batch_clear(files=None, directory='', filter_blender=True, filter_folder=True, use_scenes=True, use_collections=True, use_objects=True, use_intern_data=True, use_trusted=False, use_backups=True)

Clear selected .blend file’s previews

Parameters
  • files (bpy_prop_collection of OperatorFileListElement, (optional)) – files

  • directory (string, (optional, never None)) – directory

  • filter_blender (boolean, (optional)) – filter_blender

  • filter_folder (boolean, (optional)) – filter_folder

  • use_scenes (boolean, (optional)) – Scenes, Clear scenes’ previews

  • use_collections (boolean, (optional)) – Collections, Clear collections’ previews

  • use_objects (boolean, (optional)) – Objects, Clear objects’ previews

  • use_intern_data (boolean, (optional)) – Materials & Textures, Clear ‘internal’ previews (materials, textures, images, etc.)

  • use_trusted (boolean, (optional)) – Trusted Blend Files, Enable python evaluation for selected files

  • use_backups (boolean, (optional)) – Save Backups, Keep a backup (.blend1) version of the files when saving with cleared previews

File

startup/bl_operators/file.py:202

bpy.ops.wm.previews_batch_generate(files=None, directory='', filter_blender=True, filter_folder=True, use_scenes=True, use_collections=True, use_objects=True, use_intern_data=True, use_trusted=False, use_backups=True)

Generate selected .blend file’s previews

Parameters
  • files (bpy_prop_collection of OperatorFileListElement, (optional)) – Collection of file paths with common directory root

  • directory (string, (optional, never None)) – Root path of all files listed in files collection

  • filter_blender (boolean, (optional)) – Show Blender files in the File Browser

  • filter_folder (boolean, (optional)) – Show folders in the File Browser

  • use_scenes (boolean, (optional)) – Scenes, Generate scenes’ previews

  • use_collections (boolean, (optional)) – Collections, Generate collections’ previews

  • use_objects (boolean, (optional)) – Objects, Generate objects’ previews

  • use_intern_data (boolean, (optional)) – Materials & Textures, Generate ‘internal’ previews (materials, textures, images, etc.)

  • use_trusted (boolean, (optional)) – Trusted Blend Files, Enable python evaluation for selected files

  • use_backups (boolean, (optional)) – Save Backups, Keep a backup (.blend1) version of the files when saving with generated previews

File

startup/bl_operators/file.py:92

bpy.ops.wm.previews_clear(id_type={})

Clear data-block previews (only for some types like objects, materials, textures, etc.)

Parameters

id_type (enum set in {'ALL', 'GEOMETRY', 'SHADING', 'SCENE', 'COLLECTION', 'OBJECT', 'MATERIAL', 'LIGHT', 'WORLD', 'TEXTURE', 'IMAGE'}, (optional)) –

Data-Block Type, Which data-block previews to clear

  • ALL All Types.

  • GEOMETRY All Geometry Types – Clear previews for scenes, collections and objects.

  • SHADING All Shading Types – Clear previews for materials, lights, worlds, textures and images.

  • SCENE Scenes.

  • COLLECTION Collections.

  • OBJECT Objects.

  • MATERIAL Materials.

  • LIGHT Lights.

  • WORLD Worlds.

  • TEXTURE Textures.

  • IMAGE Images.

bpy.ops.wm.previews_ensure()

Ensure data-block previews are available and up-to-date (to be saved in .blend file, only for some types like materials, textures, etc.)

bpy.ops.wm.properties_add(data_path='')

Add your own property to the data-block

Parameters

data_path (string, (optional, never None)) – Property Edit, Property data_path edit

File

startup/bl_operators/wm.py:1950

bpy.ops.wm.properties_context_change(context='')

Jump to a different tab inside the properties editor

Parameters

context (string, (optional, never None)) – Context

File

startup/bl_operators/wm.py:1993

bpy.ops.wm.properties_edit(data_path='', property_name='', property_type='FLOAT', is_overridable_library=False, description='', use_soft_limits=False, array_length=3, default_int=(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0), min_int=- 10000, max_int=10000, soft_min_int=- 10000, soft_max_int=10000, step_int=1, default_float=(0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0), min_float=- 10000.0, max_float=- 10000.0, soft_min_float=- 10000.0, soft_max_float=- 10000.0, precision=3, step_float=0.1, subtype='NONE', default_string='', eval_string='')

Change a custom property’s type, or adjust how it is displayed in the interface

Parameters
  • data_path (string, (optional, never None)) – Property Edit, Property data_path edit

  • property_name (string, (optional, never None)) – Property Name, Property name edit

  • property_type (enum in ['FLOAT', 'FLOAT_ARRAY', 'INT', 'INT_ARRAY', 'STRING', 'PYTHON'], (optional)) –

    Type

    • FLOAT Float – A single floating-point value.

    • FLOAT_ARRAY Float Array – An array of floating-point values.

    • INT Integer – A single integer.

    • INT_ARRAY Integer Array – An array of integers.

    • STRING String – A string value.

    • PYTHON Python – Edit a python value directly, for unsupported property types.

  • is_overridable_library (boolean, (optional)) – Library Overridable, Allow the property to be overridden when the data-block is linked

  • description (string, (optional, never None)) – Description

  • use_soft_limits (boolean, (optional)) – Soft Limits, Limits the Property Value slider to a range, values outside the range must be inputted numerically

  • array_length (int in [1, 32], (optional)) – Array Length

  • default_int (int array of 32 items in [-inf, inf], (optional)) – Default Value

  • min_int (int in [-inf, inf], (optional)) – Min

  • max_int (int in [-inf, inf], (optional)) – Max

  • soft_min_int (int in [-inf, inf], (optional)) – Soft Min

  • soft_max_int (int in [-inf, inf], (optional)) – Soft Max

  • step_int (int in [1, inf], (optional)) – Step

  • default_float (float array of 32 items in [-inf, inf], (optional)) – Default Value

  • min_float (float in [-inf, inf], (optional)) – Min

  • max_float (float in [-inf, inf], (optional)) – Max

  • soft_min_float (float in [-inf, inf], (optional)) – Soft Min

  • soft_max_float (float in [-inf, inf], (optional)) – Soft Max

  • precision (int in [0, 8], (optional)) – Precision

  • step_float (float in [0.001, inf], (optional)) – Step

  • subtype (enum in ['NONE', 'COLOR', 'COLOR_GAMMA', 'EULER', 'QUATERNION'], (optional)) –

    Subtype

    • NONE Plain Data – Data values without special behavior.

    • COLOR Linear Color – Color in the linear space.

    • COLOR_GAMMA Gamma-Corrected Color – Color in the gamma corrected space.

    • EULER Euler Angles – Euler rotation angles in radians.

    • QUATERNION Quaternion Rotation – Quaternion rotation (affects NLA blending).

  • default_string (string, (optional, never None)) – Default Value

  • eval_string (string, (optional, never None)) – Value, Python value for unsupported custom property types

File

startup/bl_operators/wm.py:1699

bpy.ops.wm.properties_edit_value(data_path='', property_name='', eval_string='')

Edit the value of a custom property

Parameters
  • data_path (string, (optional, never None)) – Property Edit, Property data_path edit

  • property_name (string, (optional, never None)) – Property Name, Property name edit

  • eval_string (string, (optional, never None)) – Value, Value for custom property types that can only be edited as a Python expression

File

startup/bl_operators/wm.py:1906

bpy.ops.wm.properties_remove(data_path='', property_name='')

Internal use (edit a property data_path)

Parameters
  • data_path (string, (optional, never None)) – Property Edit, Property data_path edit

  • property_name (string, (optional, never None)) – Property Name, Property name edit

File

startup/bl_operators/wm.py:2007

bpy.ops.wm.quit_blender()

Quit Blender

bpy.ops.wm.radial_control(data_path_primary='', data_path_secondary='', use_secondary='', rotation_path='', color_path='', fill_color_path='', fill_color_override_path='', fill_color_override_test_path='', zoom_path='', image_id='', secondary_tex=False, release_confirm=False)

Set some size property (e.g. brush size) with mouse wheel

Parameters
  • data_path_primary (string, (optional, never None)) – Primary Data Path, Primary path of property to be set by the radial control

  • data_path_secondary (string, (optional, never None)) – Secondary Data Path, Secondary path of property to be set by the radial control

  • use_secondary (string, (optional, never None)) – Use Secondary, Path of property to select between the primary and secondary data paths

  • rotation_path (string, (optional, never None)) – Rotation Path, Path of property used to rotate the texture display

  • color_path (string, (optional, never None)) – Color Path, Path of property used to set the color of the control

  • fill_color_path (string, (optional, never None)) – Fill Color Path, Path of property used to set the fill color of the control

  • fill_color_override_path (string, (optional, never None)) – Fill Color Override Path

  • fill_color_override_test_path (string, (optional, never None)) – Fill Color Override Test

  • zoom_path (string, (optional, never None)) – Zoom Path, Path of property used to set the zoom level for the control

  • image_id (string, (optional, never None)) – Image ID, Path of ID that is used to generate an image for the control

  • secondary_tex (boolean, (optional)) – Secondary Texture, Tweak brush secondary/mask texture

  • release_confirm (boolean, (optional)) – Confirm On Release, Finish operation on key release

bpy.ops.wm.read_factory_settings(app_template='Template', use_empty=False)

Load factory default startup file and preferences. To make changes permanent, use “Save Startup File” and “Save Preferences”

Parameters

use_empty (boolean, (optional)) – Empty

bpy.ops.wm.read_factory_userpref()

Load factory default preferences. To make changes to preferences permanent, use “Save Preferences”

bpy.ops.wm.read_history()

Reloads history and bookmarks

bpy.ops.wm.read_homefile(filepath='', load_ui=True, use_splash=False, use_factory_startup=False, app_template='Template', use_empty=False)

Open the default file (doesn’t save the current file)

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to an alternative start-up file

  • load_ui (boolean, (optional)) – Load UI, Load user interface setup from the .blend file

  • use_splash (boolean, (optional)) – Splash

  • use_factory_startup (boolean, (optional)) – Factory Startup

  • use_empty (boolean, (optional)) – Empty

bpy.ops.wm.read_userpref()

Load last saved preferences

bpy.ops.wm.recover_auto_save(filepath='', hide_props_region=True, filter_blender=True, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_usd=False, filter_obj=False, filter_volume=False, filter_folder=False, filter_blenlib=False, filemode=8, display_type='LIST_VERTICAL', sort_method='', use_scripts=True)

Open an automatically saved file to recover it

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • hide_props_region (boolean, (optional)) – Hide Operator Properties, Collapse the region displaying the operator settings

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • use_scripts (boolean, (optional)) – Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences

bpy.ops.wm.recover_last_session(use_scripts=True)

Open the last closed file (“quit.blend”)

Parameters

use_scripts (boolean, (optional)) – Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences

bpy.ops.wm.redraw_timer(type='DRAW', iterations=10, time_limit=0.0)

Simple redraw timer to test the speed of updating the interface

Parameters
  • type (enum in ['DRAW', 'DRAW_SWAP', 'DRAW_WIN', 'DRAW_WIN_SWAP', 'ANIM_STEP', 'ANIM_PLAY', 'UNDO'], (optional)) –

    Type

    • DRAW Draw Region – Draw region.

    • DRAW_SWAP Draw Region & Swap – Draw region and swap.

    • DRAW_WIN Draw Window – Draw window.

    • DRAW_WIN_SWAP Draw Window & Swap – Draw window and swap.

    • ANIM_STEP Animation Step – Animation steps.

    • ANIM_PLAY Animation Play – Animation playback.

    • UNDO Undo/Redo – Undo and redo.

  • iterations (int in [1, inf], (optional)) – Iterations, Number of times to redraw

  • time_limit (float in [0, inf], (optional)) – Time Limit, Seconds to run the test for (override iterations)

bpy.ops.wm.revert_mainfile(use_scripts=True)

Reload the saved file

Parameters

use_scripts (boolean, (optional)) – Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences

bpy.ops.wm.save_as_mainfile(filepath='', hide_props_region=True, check_existing=True, filter_blender=True, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_usd=False, filter_obj=False, filter_volume=False, filter_folder=True, filter_blenlib=False, filemode=8, display_type='DEFAULT', sort_method='', compress=False, relative_remap=True, copy=False)

Save the current file in the desired location

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • hide_props_region (boolean, (optional)) – Hide Operator Properties, Collapse the region displaying the operator settings

  • check_existing (boolean, (optional)) – Check Existing, Check and warn on overwriting existing files

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • compress (boolean, (optional)) – Compress, Write compressed .blend file

  • relative_remap (boolean, (optional)) – Remap Relative, Remap relative paths when saving to a different directory

  • copy (boolean, (optional)) – Save Copy, Save a copy of the actual working state but does not make saved file active

bpy.ops.wm.save_homefile()

Make the current file the default .blend file

bpy.ops.wm.save_mainfile(filepath='', hide_props_region=True, check_existing=True, filter_blender=True, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_usd=False, filter_obj=False, filter_volume=False, filter_folder=True, filter_blenlib=False, filemode=8, display_type='DEFAULT', sort_method='', compress=False, relative_remap=False, exit=False)

Save the current Blender file

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • hide_props_region (boolean, (optional)) – Hide Operator Properties, Collapse the region displaying the operator settings

  • check_existing (boolean, (optional)) – Check Existing, Check and warn on overwriting existing files

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • compress (boolean, (optional)) – Compress, Write compressed .blend file

  • relative_remap (boolean, (optional)) – Remap Relative, Remap relative paths when saving to a different directory

  • exit (boolean, (optional)) – Exit, Exit Blender after saving

bpy.ops.wm.save_userpref()

Make the current preferences default

bpy.ops.wm.search_menu()

Pop-up a search over all menus in the current context

bpy.ops.wm.search_operator()

Pop-up a search over all available operators in current context

bpy.ops.wm.set_stereo_3d(display_mode='ANAGLYPH', anaglyph_type='RED_CYAN', interlace_type='ROW_INTERLEAVED', use_interlace_swap=False, use_sidebyside_crosseyed=False)

Toggle 3D stereo support for current window (or change the display mode)

Parameters
  • display_mode (enum in Stereo3D Display Items, (optional)) – Display Mode

  • anaglyph_type (enum in Stereo3D Anaglyph Type Items, (optional)) – Anaglyph Type

  • interlace_type (enum in Stereo3D Interlace Type Items, (optional)) – Interlace Type

  • use_interlace_swap (boolean, (optional)) – Swap Left/Right, Swap left and right stereo channels

  • use_sidebyside_crosseyed (boolean, (optional)) – Cross-Eyed, Right eye should see left image and vice versa

bpy.ops.wm.splash()

Open the splash screen with release info

bpy.ops.wm.splash_about()

Open a window with information about Blender

bpy.ops.wm.stl_import(filepath='', directory='', files=None, filter_blender=False, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_usd=False, filter_obj=False, filter_volume=False, filter_folder=True, filter_blenlib=False, filemode=8, display_type='DEFAULT', sort_method='', global_scale=1.0, use_scene_unit=False, use_facet_normal=False, forward_axis='Y', up_axis='Z', use_mesh_validate=False, filter_glob='*.stl')

Import an STL file as an object

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • directory (string, (optional, never None)) – Directory, Directory of the file

  • files (bpy_prop_collection of OperatorFileListElement, (optional)) – Files

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • global_scale (float in [1e-06, 1e+06], (optional)) – Scale

  • use_scene_unit (boolean, (optional)) – Scene Unit, Apply current scene’s unit (as defined by unit scale) to imported data

  • use_facet_normal (boolean, (optional)) – Facet Normals, Use (import) facet normals (note that this will still give flat shading)

  • forward_axis (enum in ['X', 'Y', 'Z', 'NEGATIVE_X', 'NEGATIVE_Y', 'NEGATIVE_Z'], (optional)) –

    Forward Axis

    • X X – Positive X axis.

    • Y Y – Positive Y axis.

    • Z Z – Positive Z axis.

    • NEGATIVE_X -X – Negative X axis.

    • NEGATIVE_Y -Y – Negative Y axis.

    • NEGATIVE_Z -Z – Negative Z axis.

  • up_axis (enum in ['X', 'Y', 'Z', 'NEGATIVE_X', 'NEGATIVE_Y', 'NEGATIVE_Z'], (optional)) –

    Up Axis

    • X X – Positive X axis.

    • Y Y – Positive Y axis.

    • Z Z – Positive Z axis.

    • NEGATIVE_X -X – Negative X axis.

    • NEGATIVE_Y -Y – Negative Y axis.

    • NEGATIVE_Z -Z – Negative Z axis.

  • use_mesh_validate (boolean, (optional)) – Validate Mesh, Validate and correct imported mesh (slow)

  • filter_glob (string, (optional, never None)) – Extension Filter

bpy.ops.wm.sysinfo(filepath='')

Generate system information, saved into a text file

Parameters

filepath (string, (optional, never None)) – filepath

File

startup/bl_operators/wm.py:2036

bpy.ops.wm.tool_set_by_id(name='', cycle=False, as_fallback=False, space_type='EMPTY')

Set the tool by name (for keymaps)

Parameters
  • name (string, (optional, never None)) – Identifier, Identifier of the tool

  • cycle (boolean, (optional)) – Cycle, Cycle through tools in this group

  • as_fallback (boolean, (optional)) – Set Fallback, Set the fallback tool instead of the primary tool

  • space_type (enum in ['EMPTY', 'VIEW_3D', 'IMAGE_EDITOR', 'NODE_EDITOR', 'SEQUENCE_EDITOR', 'CLIP_EDITOR', 'DOPESHEET_EDITOR', 'GRAPH_EDITOR', 'NLA_EDITOR', 'TEXT_EDITOR', 'CONSOLE', 'INFO', 'TOPBAR', 'STATUSBAR', 'OUTLINER', 'PROPERTIES', 'FILE_BROWSER', 'SPREADSHEET', 'PREFERENCES'], (optional)) – Type

File

startup/bl_operators/wm.py:2137

bpy.ops.wm.tool_set_by_index(index=0, cycle=False, expand=True, as_fallback=False, space_type='EMPTY')

Set the tool by index (for keymaps)

Parameters
  • index (int in [-inf, inf], (optional)) – Index in Toolbar

  • cycle (boolean, (optional)) – Cycle, Cycle through tools in this group

  • expand (boolean, (optional)) – expand, Include tool subgroups

  • as_fallback (boolean, (optional)) – Set Fallback, Set the fallback tool instead of the primary

  • space_type (enum in ['EMPTY', 'VIEW_3D', 'IMAGE_EDITOR', 'NODE_EDITOR', 'SEQUENCE_EDITOR', 'CLIP_EDITOR', 'DOPESHEET_EDITOR', 'GRAPH_EDITOR', 'NLA_EDITOR', 'TEXT_EDITOR', 'CONSOLE', 'INFO', 'TOPBAR', 'STATUSBAR', 'OUTLINER', 'PROPERTIES', 'FILE_BROWSER', 'SPREADSHEET', 'PREFERENCES'], (optional)) – Type

File

startup/bl_operators/wm.py:2189

bpy.ops.wm.toolbar()

Undocumented, consider contributing.

File

startup/bl_operators/wm.py:2244

bpy.ops.wm.toolbar_fallback_pie()

Undocumented, consider contributing.

File

startup/bl_operators/wm.py:2268

bpy.ops.wm.toolbar_prompt()

Leader key like functionality for accessing tools

File

startup/bl_operators/wm.py:2368

bpy.ops.wm.url_open(url='')

Open a website in the web browser

Parameters

url (string, (optional, never None)) – URL, URL to open

File

startup/bl_operators/wm.py:1016

bpy.ops.wm.url_open_preset(type='', id='')

Open a preset website in the web browser

Parameters
  • type (enum in [], (optional)) – Site

  • id (string, (optional, never None)) – Identifier, Optional identifier

File

startup/bl_operators/wm.py:1091

bpy.ops.wm.usd_export(filepath='', check_existing=True, filter_blender=False, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_usd=True, filter_obj=False, filter_volume=False, filter_folder=True, filter_blenlib=False, filemode=8, display_type='DEFAULT', sort_method='', selected_objects_only=False, visible_objects_only=True, export_animation=False, export_hair=False, export_uvmaps=True, export_normals=True, export_materials=True, use_instancing=False, evaluation_mode='RENDER', generate_preview_surface=True, export_textures=True, overwrite_textures=False, relative_paths=True)

Export current scene in a USD archive

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • check_existing (boolean, (optional)) – Check Existing, Check and warn on overwriting existing files

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • selected_objects_only (boolean, (optional)) – Selection Only, Only export selected objects. Unselected parents of selected objects are exported as empty transform

  • visible_objects_only (boolean, (optional)) – Visible Only, Only export visible objects. Invisible parents of exported objects are exported as empty transforms

  • export_animation (boolean, (optional)) – Animation, Export all frames in the render frame range, rather than only the current frame

  • export_hair (boolean, (optional)) – Hair, Export hair particle systems as USD curves

  • export_uvmaps (boolean, (optional)) – UV Maps, Include all mesh UV maps in the export

  • export_normals (boolean, (optional)) – Normals, Include normals of exported meshes in the export

  • export_materials (boolean, (optional)) – Materials, Export viewport settings of materials as USD preview materials, and export material assignments as geometry subsets

  • use_instancing (boolean, (optional)) – Instancing, Export instanced objects as references in USD rather than real objects

  • evaluation_mode (enum in ['RENDER', 'VIEWPORT'], (optional)) –

    Use Settings for, Determines visibility of objects, modifier settings, and other areas where there are different settings for viewport and rendering

    • RENDER Render – Use Render settings for object visibility, modifier settings, etc.

    • VIEWPORT Viewport – Use Viewport settings for object visibility, modifier settings, etc.

  • generate_preview_surface (boolean, (optional)) – To USD Preview Surface, Generate an approximate USD Preview Surface shader representation of a Principled BSDF node network

  • export_textures (boolean, (optional)) – Export Textures, If exporting materials, export textures referenced by material nodes to a ‘textures’ directory in the same directory as the USD file

  • overwrite_textures (boolean, (optional)) – Overwrite Textures, Allow overwriting existing texture files when exporting textures

  • relative_paths (boolean, (optional)) – Relative Paths, Use relative paths to reference external files (i.e. textures, volumes) in USD, otherwise use absolute paths

bpy.ops.wm.usd_import(filepath='', filter_blender=False, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_archive=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_usd=True, filter_obj=False, filter_volume=False, filter_folder=True, filter_blenlib=False, filemode=8, relative_path=True, display_type='DEFAULT', sort_method='', scale=1.0, set_frame_range=True, import_cameras=True, import_curves=True, import_lights=True, import_materials=True, import_meshes=True, import_volumes=True, import_subdiv=False, import_instance_proxies=True, import_visible_only=True, create_collection=False, read_mesh_uvs=True, read_mesh_colors=False, prim_path_mask='', import_guide=False, import_proxy=True, import_render=True, import_usd_preview=False, set_material_blend=True, light_intensity_scale=1.0, mtl_name_collision_mode='MAKE_UNIQUE')

Import USD stage into current scene

Parameters
  • filepath (string, (optional, never None)) – File Path, Path to file

  • filter_blender (boolean, (optional)) – Filter .blend files

  • filter_backup (boolean, (optional)) – Filter .blend files

  • filter_image (boolean, (optional)) – Filter image files

  • filter_movie (boolean, (optional)) – Filter movie files

  • filter_python (boolean, (optional)) – Filter python files

  • filter_font (boolean, (optional)) – Filter font files

  • filter_sound (boolean, (optional)) – Filter sound files

  • filter_text (boolean, (optional)) – Filter text files

  • filter_archive (boolean, (optional)) – Filter archive files

  • filter_btx (boolean, (optional)) – Filter btx files

  • filter_collada (boolean, (optional)) – Filter COLLADA files

  • filter_alembic (boolean, (optional)) – Filter Alembic files

  • filter_usd (boolean, (optional)) – Filter USD files

  • filter_obj (boolean, (optional)) – Filter OBJ files

  • filter_volume (boolean, (optional)) – Filter OpenVDB volume files

  • filter_folder (boolean, (optional)) – Filter folders

  • filter_blenlib (boolean, (optional)) – Filter Blender IDs

  • filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file

  • relative_path (boolean, (optional)) – Relative Path, Select the file relative to the blend file

  • display_type (enum in ['DEFAULT', 'LIST_VERTICAL', 'LIST_HORIZONTAL', 'THUMBNAIL'], (optional)) –

    Display Type

    • DEFAULT Default – Automatically determine display type for files.

    • LIST_VERTICAL Short List – Display files as short list.

    • LIST_HORIZONTAL Long List – Display files as a detailed list.

    • THUMBNAIL Thumbnails – Display files as thumbnails.

  • sort_method (enum in [], (optional)) – File sorting mode

  • scale (float in [0.0001, 1000], (optional)) – Scale, Value by which to enlarge or shrink the objects with respect to the world’s origin

  • set_frame_range (boolean, (optional)) – Set Frame Range, Update the scene’s start and end frame to match those of the USD archive

  • import_cameras (boolean, (optional)) – Cameras

  • import_curves (boolean, (optional)) – Curves

  • import_lights (boolean, (optional)) – Lights

  • import_materials (boolean, (optional)) – Materials

  • import_meshes (boolean, (optional)) – Meshes

  • import_volumes (boolean, (optional)) – Volumes

  • import_subdiv (boolean, (optional)) – Import Subdivision Scheme, Create subdivision surface modifiers based on the USD SubdivisionScheme attribute

  • import_instance_proxies (boolean, (optional)) – Import Instance Proxies, Create unique Blender objects for USD instances

  • import_visible_only (boolean, (optional)) – Visible Primitives Only, Do not import invisible USD primitives. Only applies to primitives with a non-animated visibility attribute. Primitives with animated visibility will always be imported

  • create_collection (boolean, (optional)) – Create Collection, Add all imported objects to a new collection

  • read_mesh_uvs (boolean, (optional)) – UV Coordinates, Read mesh UV coordinates

  • read_mesh_colors (boolean, (optional)) – Color Attributes, Read mesh color attributes

  • prim_path_mask (string, (optional, never None)) – Path Mask, Import only the subset of the USD scene rooted at the given primitive

  • import_guide (boolean, (optional)) – Guide, Import guide geometry

  • import_proxy (boolean, (optional)) – Proxy, Import proxy geometry

  • import_render (boolean, (optional)) – Render, Import final render geometry

  • import_usd_preview (boolean, (optional)) – Import USD Preview, Convert UsdPreviewSurface shaders to Principled BSDF shader networks

  • set_material_blend (boolean, (optional)) – Set Material Blend, If the Import USD Preview option is enabled, the material blend method will automatically be set based on the shader’s opacity and opacityThreshold inputs

  • light_intensity_scale (float in [0.0001, 10000], (optional)) – Light Intensity Scale, Scale for the intensity of imported lights

  • mtl_name_collision_mode (enum in ['MAKE_UNIQUE', 'REFERENCE_EXISTING'], (optional)) –

    Material Name Collision, Behavior when the name of an imported material conflicts with an existing material

    • MAKE_UNIQUE Make Unique – Import each USD material as a unique Blender material.

    • REFERENCE_EXISTING Reference Existing – If a material with the same name already exists, reference that instead of importing.

bpy.ops.wm.window_close()

Close the current window

bpy.ops.wm.window_fullscreen_toggle()

Toggle the current window full-screen

bpy.ops.wm.window_new()

Create a new window

bpy.ops.wm.window_new_main()

Create a new main window with its own workspace and scene selection

bpy.ops.wm.xr_navigation_fly(mode='VIEWER_FORWARD', lock_location_z=False, lock_direction=False, speed_frame_based=True, speed_min=0.018, speed_max=0.054, speed_interpolation0=(0.0, 0.0), speed_interpolation1=(1.0, 1.0))

Move/turn relative to the VR viewer or controller

Parameters
  • mode (enum in ['FORWARD', 'BACK', 'LEFT', 'RIGHT', 'UP', 'DOWN', 'TURNLEFT', 'TURNRIGHT', 'VIEWER_FORWARD', 'VIEWER_BACK', 'VIEWER_LEFT', 'VIEWER_RIGHT', 'CONTROLLER_FORWARD'], (optional)) –

    Mode, Fly mode

    • FORWARD Forward – Move along navigation forward axis.

    • BACK Back – Move along navigation back axis.

    • LEFT Left – Move along navigation left axis.

    • RIGHT Right – Move along navigation right axis.

    • UP Up – Move along navigation up axis.

    • DOWN Down – Move along navigation down axis.

    • TURNLEFT Turn Left – Turn counter-clockwise around navigation up axis.

    • TURNRIGHT Turn Right – Turn clockwise around navigation up axis.

    • VIEWER_FORWARD Viewer Forward – Move along viewer’s forward axis.

    • VIEWER_BACK Viewer Back – Move along viewer’s back axis.

    • VIEWER_LEFT Viewer Left – Move along viewer’s left axis.

    • VIEWER_RIGHT Viewer Right – Move along viewer’s right axis.

    • CONTROLLER_FORWARD Controller Forward – Move along controller’s forward axis.

  • lock_location_z (boolean, (optional)) – Lock Elevation, Prevent changes to viewer elevation

  • lock_direction (boolean, (optional)) – Lock Direction, Limit movement to viewer’s initial direction

  • speed_frame_based (boolean, (optional)) – Frame Based Speed, Apply fixed movement deltas every update

  • speed_min (float in [0, 1000], (optional)) – Minimum Speed, Minimum move (turn) speed in meters (radians) per second or frame

  • speed_max (float in [0, 1000], (optional)) – Maximum Speed, Maximum move (turn) speed in meters (radians) per second or frame

  • speed_interpolation0 (float array of 2 items in [0, 1], (optional)) – Speed Interpolation 0, First cubic spline control point between min/max speeds

  • speed_interpolation1 (float array of 2 items in [0, 1], (optional)) – Speed Interpolation 1, Second cubic spline control point between min/max speeds

bpy.ops.wm.xr_navigation_grab(lock_location=False, lock_location_z=False, lock_rotation=False, lock_rotation_z=False, lock_scale=False)

Navigate the VR scene by grabbing with controllers

Parameters
  • lock_location (boolean, (optional)) – Lock Location, Prevent changes to viewer location

  • lock_location_z (boolean, (optional)) – Lock Elevation, Prevent changes to viewer elevation

  • lock_rotation (boolean, (optional)) – Lock Rotation, Prevent changes to viewer rotation

  • lock_rotation_z (boolean, (optional)) – Lock Up Orientation, Prevent changes to viewer up orientation

  • lock_scale (boolean, (optional)) – Lock Scale, Prevent changes to viewer scale

bpy.ops.wm.xr_navigation_reset(location=True, rotation=True, scale=True)

Reset VR navigation deltas relative to session base pose

Parameters
  • location (boolean, (optional)) – Location, Reset location deltas

  • rotation (boolean, (optional)) – Rotation, Reset rotation deltas

  • scale (boolean, (optional)) – Scale, Reset scale deltas

bpy.ops.wm.xr_navigation_teleport(teleport_axes=(True, True, True), interpolation=1.0, offset=0.0, selectable_only=True, distance=1.70141e+38, from_viewer=False, axis=(0.0, 0.0, - 1.0), color=(0.35, 0.35, 1.0, 1.0))

Set VR viewer location to controller raycast hit location

Parameters
  • teleport_axes (boolean array of 3 items, (optional)) – Teleport Axes, Enabled teleport axes in navigation space

  • interpolation (float in [0, 1], (optional)) – Interpolation, Interpolation factor between viewer and hit locations

  • offset (float in [0, inf], (optional)) – Offset, Offset along hit normal to subtract from final location

  • selectable_only (boolean, (optional)) – Selectable Only, Only allow selectable objects to influence raycast result

  • distance (float in [0, inf], (optional)) – Maximum raycast distance

  • from_viewer (boolean, (optional)) – From Viewer, Use viewer pose as raycast origin

  • axis (float array of 3 items in [-1, 1], (optional)) – Axis, Raycast axis in controller/viewer space

  • color (float array of 4 items in [0, 1], (optional)) – Color, Raycast color

bpy.ops.wm.xr_session_toggle()

Open a view for use with virtual reality headsets, or close it if already opened