Wm Operators

bpy.ops.wm.append(filepath='', directory='', filename='', files=None, check_existing=False, 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, clear_asset_data=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
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
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
clear_asset_data (boolean, (optional)) – Clear Asset Data, Don’t add asset meta-data or tags from the original data-block
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', 'ACTION_CLIP'], (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:3182

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:290

bpy.ops.wm.blenderplayer_start()

Launch the blender-player with the current blend-file

File:: startup/bl_operators/wm.py:2220

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.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:865

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:668

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:619

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

Set a context value (useful for cycling active material, shape 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:579

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:697

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:1002

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:728

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:334

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:372

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:263

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:263

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:263

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:809

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:263

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:263

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:475

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:499

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:540

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:1359

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:1331

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:3530

bpy.ops.wm.gpencil_import_svg(filepath='', directory='', files=None, check_existing=False, 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, 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
directory (string, (optional, never None)) – Directory, Directory of the file
files (bpy_prop_collection of OperatorFileListElement, (optional)) – Files
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
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:75

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:75

bpy.ops.wm.lib_reload(library='', filepath='', directory='', filename='', hide_props_region=True, check_existing=False, 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
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
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, check_existing=False, 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
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
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.link(filepath='', directory='', filename='', files=None, check_existing=False, 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, relative_path=True, display_type='DEFAULT', sort_method='', link=True, do_reuse_local_id=False, clear_asset_data=False, autoselect=True, active_collection=True, instance_collections=True, instance_object_data=True)

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
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
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
clear_asset_data (boolean, (optional)) – Clear Asset Data, Don’t add asset meta-data or tags from the original data-block
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', global_scale=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, export_pbr_extensions=False, 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.
global_scale (float in [0.0001, 10000], (optional)) – Scale, Value by which to enlarge or shrink the objects with respect to the world’s origin
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
export_pbr_extensions (boolean, (optional)) – Export Materials with PBR Extensions, Export MTL library using PBR extensions (roughness, metallic, sheen, clearcoat, anisotropy, transmission)
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='', directory='', files=None, check_existing=False, 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, clamp_size=0.0, forward_axis='NEGATIVE_Z', up_axis='Y', use_split_objects=True, use_split_groups=False, 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
directory (string, (optional, never None)) – Directory, Directory of the file
files (bpy_prop_collection of OperatorFileListElement, (optional)) – Files
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
global_scale (float in [0.0001, 10000], (optional)) – Scale, Value by which to enlarge or shrink the objects with respect to the world’s origin
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.
use_split_objects (boolean, (optional)) – Split By Object, Import each OBJ ‘o’ as a separate object
use_split_groups (boolean, (optional)) – Split By Group, Import each OBJ ‘g’ as a separate object
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, check_existing=False, 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
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
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:2270

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:769

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:75

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

Disable add-on for workspace

Parameters:: owner_id (string, (optional, never None)) – UI Tag
File:: startup/bl_operators/wm.py:2318

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

Enable add-on for workspace

Parameters:: owner_id (string, (optional, never None)) – UI Tag
File:: startup/bl_operators/wm.py:2303

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:1160

bpy.ops.wm.ply_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='', forward_axis='Y', up_axis='Z', global_scale=1.0, apply_modifiers=True, export_selected_objects=False, export_uv=True, export_normals=False, export_colors='SRGB', export_triangulated_mesh=False, ascii_format=False, filter_glob='*.ply')

Save the scene to a PLY 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
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.
global_scale (float in [0.0001, 10000], (optional)) – Scale, Value by which to enlarge or shrink the objects with respect to the world’s origin
apply_modifiers (boolean, (optional)) – Apply Modifiers, Apply modifiers to exported meshes
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 Vertex Normals, Export specific vertex normals if available, export calculated normals otherwise
export_colors (enum in ['NONE', 'SRGB', 'LINEAR'], (optional)) –
Export Vertex Colors, Export vertex color attributes
- NONE None – Do not import/export color attributes.
- SRGB sRGB – Vertex colors in the file are in sRGB color space.
- LINEAR Linear – Vertex colors in the file are in linear color space.
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
ascii_format (boolean, (optional)) – ASCII Format, Export file in ASCII format, export as binary otherwise
filter_glob (string, (optional, never None)) – Extension Filter

bpy.ops.wm.ply_import(filepath='', directory='', files=None, check_existing=False, 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, forward_axis='Y', up_axis='Z', merge_verts=False, import_colors='SRGB', filter_glob='*.ply')

Import an PLY 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
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
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
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.
merge_verts (boolean, (optional)) – Merge Vertices, Merges vertices by distance
import_colors (enum in ['NONE', 'SRGB', 'LINEAR'], (optional)) –
Import Vertex Colors, Import vertex color attributes
- NONE None – Do not import/export color attributes.
- SRGB sRGB – Vertex colors in the file are in sRGB color space.
- LINEAR Linear – Vertex colors in the file are in linear color space.
filter_glob (string, (optional, never None)) – Extension Filter

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:205

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:95

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:2112

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:2155

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_bool=(False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False), 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='', default_string='', id_type='OBJECT', 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', 'BOOL', 'BOOL_ARRAY', 'STRING', 'DATA_BLOCK', '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.
- BOOL Boolean – A true or false value.
- BOOL_ARRAY Boolean Array – An array of true or false values.
- STRING String – A string value.
- DATA_BLOCK Data-Block – A data-block 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_bool (boolean array of 32 items, (optional)) – Default Value
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 [], (optional)) – Subtype
default_string (string, (optional, never None)) – Default Value
id_type (enum in ['ACTION', 'ARMATURE', 'BRUSH', 'CACHEFILE', 'CAMERA', 'COLLECTION', 'CURVE', 'CURVES', 'FONT', 'GREASEPENCIL', 'GREASEPENCIL_V3', 'IMAGE', 'KEY', 'LATTICE', 'LIBRARY', 'LIGHT', 'LIGHT_PROBE', 'LINESTYLE', 'MASK', 'MATERIAL', 'MESH', 'META', 'MOVIECLIP', 'NODETREE', 'OBJECT', 'PAINTCURVE', 'PALETTE', 'PARTICLE', 'POINTCLOUD', 'SCENE', 'SOUND', 'SPEAKER', 'TEXT', 'TEXTURE', 'VOLUME', 'WINDOWMANAGER', 'WORKSPACE', 'WORLD'], (optional)) – ID Type
eval_string (string, (optional, never None)) – Value, Python value for unsupported custom property types

File:

startup/bl_operators/wm.py:1849

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:2068

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:2169

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(use_factory_startup_app_template_only=False, 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_factory_startup_app_template_only (boolean, (optional)) – Factory Startup App-Template Only
use_empty (boolean, (optional)) – Empty

bpy.ops.wm.read_factory_userpref(use_factory_startup_app_template_only=False)

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

Parameters:: use_factory_startup_app_template_only (boolean, (optional)) – Factory Startup App-Template Only

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, use_factory_startup_app_template_only=False, app_template='Template', use_empty=False)

Open the default 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_factory_startup_app_template_only (boolean, (optional)) – Factory Startup App-Template Only
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, check_existing=False, 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
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_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, incremental=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
incremental (boolean, (optional)) – Incremental, Save the current Blender file with a numerically incremented name that does not overwrite any existing files

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.search_single_menu(menu_idname='', initial_query='')

Pop-up a search for a menu in current context

Parameters:

menu_idname (string, (optional, never None)) – Menu Name, Menu to search in
initial_query (string, (optional, never None)) – Initial Query, Query to insert into the search box

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 UPBGE

bpy.ops.wm.stl_import(filepath='', directory='', files=None, check_existing=False, 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
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
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:2198

bpy.ops.wm.tool_set_by_id(name='', cycle=False, as_fallback=False, space_type='EMPTY')

Set the tool by name (for key-maps)

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', 'LOGIC_EDITOR', 'CONSOLE', 'INFO', 'TOPBAR', 'STATUSBAR', 'OUTLINER', 'PROPERTIES', 'FILE_BROWSER', 'SPREADSHEET', 'PREFERENCES'], (optional)) – Type

File:

startup/bl_operators/wm.py:2349

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 key-maps)

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', 'LOGIC_EDITOR', 'CONSOLE', 'INFO', 'TOPBAR', 'STATUSBAR', 'OUTLINER', 'PROPERTIES', 'FILE_BROWSER', 'SPREADSHEET', 'PREFERENCES'], (optional)) – Type

File: