Wm Operators¶
- bpy.ops.wm.addon_disable(module="")¶
Disable an addon
Parameters: - module (string, (optional)) – Module, Module name of the addon to disable
File :
- bpy.ops.wm.addon_enable(module="")¶
Enable an addon
Parameters: - module (string, (optional)) – Module, Module name of the addon to enable
File :
- bpy.ops.wm.addon_expand(module="")¶
Display more information on this add-on
Parameters: - module (string, (optional)) – Module, Module name of the addon to expand
File :
- bpy.ops.wm.addon_install(overwrite=True, target='DEFAULT', filepath="", filter_folder=True, filter_python=True, filter_glob="*.py;*.zip")¶
Install an addon
Parameters: - overwrite (boolean, (optional)) – Overwrite, Remove existing addons with the same ID
- target (enum in [‘DEFAULT’, ‘PREFS’], (optional)) – Target Path
- filepath (string, (optional)) – File Path, File path to write file to
- filter_folder (boolean, (optional)) – Filter folders
- filter_python (boolean, (optional)) – Filter python
File :
- bpy.ops.wm.appconfig_activate(filepath="")¶
Undocumented (contribute)
Parameters: - filepath (string, (optional)) – File Path
File :
- bpy.ops.wm.appconfig_default()¶
Undocumented (contribute)
File : startup/bl_operators/wm.py:882
Undocumented (contribute)
Parameters: - name (string, (optional)) – Name, Name of the menu
- 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)) – Context Attributes, rna context string
- reverse (boolean, (optional)) – Reverse, Cycle backwards
File :
- bpy.ops.wm.context_cycle_enum(data_path="", reverse=False)¶
Toggle a context value.
Parameters: - data_path (string, (optional)) – Context Attributes, rna context string
- reverse (boolean, (optional)) – Reverse, Cycle backwards
File :
- bpy.ops.wm.context_cycle_int(data_path="", reverse=False)¶
Set a context value. Useful for cycling active material,
Parameters: - data_path (string, (optional)) – Context Attributes, rna context string
- reverse (boolean, (optional)) – Reverse, Cycle backwards
File :
Undocumented (contribute)
Parameters: - data_path (string, (optional)) – Context Attributes, rna context string
File :
- bpy.ops.wm.context_modal_mouse(data_path_iter="", data_path_item="", input_scale=0.01, invert=False, initial_x=0)¶
Adjust arbitrary values with mouse input
Parameters: - data_path_iter (string, (optional)) – The data path relative to the context, must point to an iterable.
- data_path_item (string, (optional)) – The data path from each iterable to the value (int or float)
- input_scale (float in [-inf, inf], (optional)) – Scale the mouse movement by this value before applying the delta
- invert (boolean, (optional)) – Invert the mouse input
File :
- bpy.ops.wm.context_scale_int(data_path="", value=1.0, always_step=True)¶
Scale an int context value.
Parameters: - data_path (string, (optional)) – Context Attributes, rna context string
- 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 :
- bpy.ops.wm.context_set_boolean(data_path="", value=True)¶
Set a context value.
Parameters: - data_path (string, (optional)) – Context Attributes, rna context string
- value (boolean, (optional)) – Value, Assignment value
File :
- bpy.ops.wm.context_set_enum(data_path="", value="")¶
Set a context value.
Parameters: - data_path (string, (optional)) – Context Attributes, rna context string
- value (string, (optional)) – Value, Assignment value (as a string)
File :
- bpy.ops.wm.context_set_float(data_path="", value=0.0, relative=False)¶
Set a context value.
Parameters: - data_path (string, (optional)) – Context Attributes, rna context string
- value (float in [-inf, inf], (optional)) – Value, Assignment value
- relative (boolean, (optional)) – Relative, Apply relative to the current value (delta)
File :
- bpy.ops.wm.context_set_id(data_path="", value="")¶
Toggle a context value.
Parameters: - data_path (string, (optional)) – Context Attributes, rna context string
- value (string, (optional)) – Value, Assign value
File :
- bpy.ops.wm.context_set_int(data_path="", value=0, relative=False)¶
Set a context value.
Parameters: - data_path (string, (optional)) – Context Attributes, rna context string
- value (int in [-inf, inf], (optional)) – Value, Assign value
- relative (boolean, (optional)) – Relative, Apply relative to the current value (delta)
File :
- bpy.ops.wm.context_set_string(data_path="", value="")¶
Set a context value.
Parameters: - data_path (string, (optional)) – Context Attributes, rna context string
- value (string, (optional)) – Value, Assign value
File :
- bpy.ops.wm.context_set_value(data_path="", value="")¶
Set a context value.
Parameters: - data_path (string, (optional)) – Context Attributes, rna context string
- value (string, (optional)) – Value, Assignment value (as a string)
File :
- bpy.ops.wm.context_toggle(data_path="")¶
Toggle a context value.
Parameters: - data_path (string, (optional)) – Context Attributes, rna context string
File :
- bpy.ops.wm.context_toggle_enum(data_path="", value_1="", value_2="")¶
Toggle a context value.
Parameters: - data_path (string, (optional)) – Context Attributes, rna context string
- value_1 (string, (optional)) – Value, Toggle enum
- value_2 (string, (optional)) – Value, Toggle enum
File :
- bpy.ops.wm.copy_prev_settings()¶
Copy settings from previous version
File : startup/bl_operators/wm.py:929
Open a popup to set the debug level
Parameters: - debug_value (int in [-10000, 10000], (optional)) – Debug Value
- bpy.ops.wm.doc_edit(doc_id="", doc_new="")¶
Load online reference docs
Parameters: - doc_id (string, (optional)) – Doc ID
- doc_new (string, (optional)) – Edit Description
File :
- bpy.ops.wm.doc_view(doc_id="")¶
Load online reference docs
Parameters: - doc_id (string, (optional)) – Doc ID
File :
- bpy.ops.wm.interaction_preset_add(name="", remove_active=False)¶
Add an Application Interaction Preset
Parameters: - name (string, (optional)) – Name, Name of the preset, used to make the path name
File :
- bpy.ops.wm.keyconfig_activate(filepath="")¶
Undocumented (contribute)
Parameters: - filepath (string, (optional)) – File Path
File :
- bpy.ops.wm.keyconfig_export(filepath="keymap.py", filter_folder=True, filter_text=True, filter_python=True)¶
Export key configuration to a python script
Parameters: - filepath (string, (optional)) – File Path, Filepath to write file to
- filter_folder (boolean, (optional)) – Filter folders
- filter_text (boolean, (optional)) – Filter text
- filter_python (boolean, (optional)) – Filter python
File :
- bpy.ops.wm.keyconfig_import(filepath="keymap.py", filter_folder=True, filter_text=True, filter_python=True, keep_original=True)¶
Import key configuration from a python script
Parameters: - filepath (string, (optional)) – File Path, Filepath to write file to
- filter_folder (boolean, (optional)) – Filter folders
- filter_text (boolean, (optional)) – Filter text
- filter_python (boolean, (optional)) – Filter python
- keep_original (boolean, (optional)) – Keep original, Keep original file after copying to configuration folder
File :
- bpy.ops.wm.keyconfig_preset_add(name="", remove_active=False)¶
Add a Keyconfig Preset
Parameters: - name (string, (optional)) – Name, Name of the preset, used to make the path name
File :
- bpy.ops.wm.keyconfig_remove()¶
Remove key config
File : startup/bl_ui/space_userpref_keymap.py:773
- bpy.ops.wm.keyconfig_test()¶
Test keyconfig for conflicts
File : startup/bl_ui/space_userpref_keymap.py:513
- bpy.ops.wm.keyitem_add()¶
Add key map item
File : startup/bl_ui/space_userpref_keymap.py:725
- bpy.ops.wm.keyitem_remove(item_id=0)¶
Remove key map item
Parameters: - item_id (int in [-inf, inf], (optional)) – Item Identifier, Identifier of the item to remove
File :
- bpy.ops.wm.keyitem_restore(item_id=0)¶
Restore key map item
Parameters: - item_id (int in [-inf, inf], (optional)) – Item Identifier, Identifier of the item to remove
File :
- bpy.ops.wm.keymap_edit()¶
Edit stored key map
File : startup/bl_ui/space_userpref_keymap.py:672
- bpy.ops.wm.keymap_restore(all=False)¶
Restore key map(s)
Parameters: - all (boolean, (optional)) – All Keymaps, Restore all keymaps to default
File :
- bpy.ops.wm.link_append(filepath="", directory="", filename="", filter_blender=True, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_btx=False, filter_collada=False, filter_folder=True, filemode=1, relative_path=False, link=True, autoselect=True, active_layer=True, instance_groups=True, files=None)¶
Link or Append from a Library .blend file
Parameters: - filepath (string, (optional)) – File Path, Path to file
- directory (string, (optional)) – Directory, Directory of the file
- filename (string, (optional)) – File Name, Name of the file
- filter_blender (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_btx (boolean, (optional)) – Filter btx files
- filter_collada (boolean, (optional)) – Filter COLLADA files
- filter_folder (boolean, (optional)) – Filter folders
- 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
- link (boolean, (optional)) – Link, Link the objects or datablocks rather than appending
- autoselect (boolean, (optional)) – Select, Select the linked objects
- active_layer (boolean, (optional)) – Active Layer, Put the linked objects on the active layer
- instance_groups (boolean, (optional)) – Instance Groups, Create instances for each group as a DupliGroup
- files (bpy_prop_collection of OperatorFileListElement, (optional)) – Files
- bpy.ops.wm.memory_statistics()¶
Print memory statistics to the console
- bpy.ops.wm.open_mainfile(filepath="", filter_blender=True, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_btx=False, filter_collada=False, filter_folder=True, filemode=8, load_ui=True, use_scripts=True)¶
Open a Blender file
Parameters: - filepath (string, (optional)) – File Path, Path to file
- filter_blender (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_btx (boolean, (optional)) – Filter btx files
- filter_collada (boolean, (optional)) – Filter COLLADA files
- filter_folder (boolean, (optional)) – Filter folders
- 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
- load_ui (boolean, (optional)) – Load UI, Load user interface setup in the .blend file
- use_scripts (boolean, (optional)) – Trusted Source, Allow blend file execute scripts automatically, default available from system preferences
- bpy.ops.wm.operator_preset_add(name="", remove_active=False, operator="")¶
Add an Application Interaction Preset
Parameters: - name (string, (optional)) – Name, Name of the preset, used to make the path name
- operator (string, (optional)) – Operator
File :
- bpy.ops.wm.path_open(filepath="")¶
Open a path in a file browser
Parameters: - filepath (string, (optional)) – File Path
File :
- bpy.ops.wm.properties_add(data_path="")¶
Internal use (edit a property data_path)
Parameters: - data_path (string, (optional)) – Property Edit, Property data_path edit
File :
- bpy.ops.wm.properties_context_change(context="")¶
Change the context tab in a Properties Window
Parameters: - context (string, (optional)) – Context
File :
- bpy.ops.wm.properties_edit(data_path="", property="", value="", min=0.0, max=1.0, description="")¶
Internal use (edit a property data_path)
Parameters: - data_path (string, (optional)) – Property Edit, Property data_path edit
- property (string, (optional)) – Property Name, Property name edit
- value (string, (optional)) – Property Value, Property value edit
- min (float in [-inf, inf], (optional)) – Min
- max (float in [-inf, inf], (optional)) – Max
- description (string, (optional)) – Tip
File :
- bpy.ops.wm.properties_remove(data_path="", property="")¶
Internal use (edit a property data_path)
Parameters: - data_path (string, (optional)) – Property Edit, Property data_path edit
- property (string, (optional)) – Property Name, Property name edit
File :
- bpy.ops.wm.quit_blender()¶
Quit Blender
- bpy.ops.wm.radial_control(data_path="", rotation_path="", color_path="", fill_color_path="", zoom_path="", image_id="")¶
Undocumented (contribute)
Parameters: - data_path (string, (optional)) – Data Path, Path of property to be set by the radial control.
- rotation_path (string, (optional)) – Rotation Path, Path of property used to rotate the texture display.
- color_path (string, (optional)) – Color Path, Path of property used to set the color of the control.
- fill_color_path (string, (optional)) – Fill Color Path, Path of property used to set the fill color of the control.
- zoom_path (string, (optional)) – Zoom Path, Path of property used to set the zoom level for the control.
- image_id (string, (optional)) – Image ID, Path of ID that is used to generate an image for the control.
- bpy.ops.wm.read_factory_settings()¶
Load default file and user preferences
- bpy.ops.wm.read_homefile()¶
Open the default file (doesn’t save the current file)
- bpy.ops.wm.recover_auto_save(filepath="", filter_blender=True, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_btx=False, filter_collada=False, filter_folder=False, filemode=8)¶
Open an automatically saved file to recover it
Parameters: - filepath (string, (optional)) – File Path, Path to file
- filter_blender (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_btx (boolean, (optional)) – Filter btx files
- filter_collada (boolean, (optional)) – Filter COLLADA files
- filter_folder (boolean, (optional)) – Filter folders
- 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
- bpy.ops.wm.recover_last_session()¶
Open the last closed file (“quit.blend”)
- bpy.ops.wm.redraw_timer(type='DRAW', iterations=10)¶
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
- iterations (int in [1, inf], (optional)) – Iterations, Number of times to redraw
- bpy.ops.wm.save_as_mainfile(filepath="", check_existing=True, filter_blender=True, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_btx=False, filter_collada=False, filter_folder=True, filemode=8, compress=False, relative_remap=True, copy=False)¶
Save the current file in the desired location
Parameters: - filepath (string, (optional)) – 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_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_btx (boolean, (optional)) – Filter btx files
- filter_collada (boolean, (optional)) – Filter COLLADA files
- filter_folder (boolean, (optional)) – Filter folders
- 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
- compress (boolean, (optional)) – Compress, Write compressed .blend file
- relative_remap (boolean, (optional)) – Remap Relative, Remap relative paths when saving in 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="", check_existing=True, filter_blender=True, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_btx=False, filter_collada=False, filter_folder=True, filemode=8, compress=False, relative_remap=False)¶
Save the current Blender file
Parameters: - filepath (string, (optional)) – 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_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_btx (boolean, (optional)) – Filter btx files
- filter_collada (boolean, (optional)) – Filter COLLADA files
- filter_folder (boolean, (optional)) – Filter folders
- 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
- compress (boolean, (optional)) – Compress, Write compressed .blend file
- relative_remap (boolean, (optional)) – Remap Relative, Remap relative paths when saving in a different directory
Undocumented (contribute)
- bpy.ops.wm.splash()¶
Opens a blocking popup region with release info
- bpy.ops.wm.sysinfo()¶
Generate System Info
File : startup/bl_operators/wm.py:918
- bpy.ops.wm.url_open(url="")¶
Open a website in the Webbrowser
Parameters: - url (string, (optional)) – URL, URL to open
File :
- bpy.ops.wm.window_duplicate()¶
Duplicate the current Blender window
- bpy.ops.wm.window_fullscreen_toggle()¶
Toggle the current window fullscreen
