Preferences Operators¶

bpy.ops.preferences.addon_disable(module='')¶

Disable an add-on

Parameters: module (string, (optional, never None)) – Module, Module name of the add-on to disable
File: startup/bl_operators/userpref.py:474

bpy.ops.preferences.addon_enable(module='')¶

Enable an add-on

Parameters: module (string, (optional, never None)) – Module, Module name of the add-on to enable
File: startup/bl_operators/userpref.py:428

bpy.ops.preferences.addon_expand(module='')¶

Display information and preferences for this add-on

Parameters: module (string, (optional, never None)) – Module, Module name of the add-on to expand
File: startup/bl_operators/userpref.py:798

bpy.ops.preferences.addon_install(overwrite=True, target='DEFAULT', filepath='', filter_folder=True, filter_python=True, filter_glob='*.py;*.zip')¶

Install an add-on

Parameters

overwrite (boolean, (optional)) – Overwrite, Remove existing add-ons with the same ID
target (enum in ['DEFAULT', 'PREFS'], (optional)) – Target Path
filepath (string, (optional, never None)) – filepath
filter_folder (boolean, (optional)) – Filter folders
filter_python (boolean, (optional)) – Filter python
filter_glob (string, (optional, never None)) – filter_glob

File

startup/bl_operators/userpref.py:606

bpy.ops.preferences.addon_refresh()¶

Scan add-on directories for new modules

File: startup/bl_operators/userpref.py:560

bpy.ops.preferences.addon_remove(module='')¶

Delete the add-on from the file system

Parameters: module (string, (optional, never None)) – Module, Module name of the add-on to remove
File: startup/bl_operators/userpref.py:753

bpy.ops.preferences.addon_show(module='')¶

Show add-on preferences

Parameters: module (string, (optional, never None)) – Module, Module name of the add-on to expand
File: startup/bl_operators/userpref.py:822

bpy.ops.preferences.app_template_install(overwrite=True, filepath='', filter_folder=True, filter_glob='*.zip')¶

Install an application template

Parameters

overwrite (boolean, (optional)) – Overwrite, Remove existing template with the same ID
filepath (string, (optional, never None)) – filepath
filter_folder (boolean, (optional)) – Filter folders
filter_glob (string, (optional, never None)) – filter_glob

File

startup/bl_operators/userpref.py:868

bpy.ops.preferences.asset_library_add()¶: Add a path to a .blend file to be used by the Asset Browser as source of assets

bpy.ops.preferences.asset_library_remove(index=0)¶

Remove a path to a .blend file, so the Asset Browser will not attempt to show it anymore

Parameters: index (int in [0, inf], (optional)) – Index

bpy.ops.preferences.autoexec_path_add()¶: Add path to exclude from auto-execution

bpy.ops.preferences.autoexec_path_remove(index=0)¶

Remove path to exclude from auto-execution

Parameters: index (int in [0, inf], (optional)) – Index

bpy.ops.preferences.copy_prev()¶

Copy settings from previous version

File: startup/bl_operators/userpref.py:145

bpy.ops.preferences.keyconfig_activate(filepath='')¶

Undocumented, consider contributing.

Parameters: filepath (string, (optional, never None)) – filepath
File: startup/bl_operators/userpref.py:79

bpy.ops.preferences.keyconfig_export(all=False, filepath='keymap.py', filter_folder=True, filter_text=True, filter_python=True)¶

Export key configuration to a python script

Parameters

all (boolean, (optional)) – All Keymaps, Write all keymaps (not just user modified)
filepath (string, (optional, never None)) – filepath
filter_folder (boolean, (optional)) – Filter folders
filter_text (boolean, (optional)) – Filter text
filter_python (boolean, (optional)) – Filter python

File

startup/bl_operators/userpref.py:276

bpy.ops.preferences.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, never None)) – filepath
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

startup/bl_operators/userpref.py:209

bpy.ops.preferences.keyconfig_remove()¶

Remove key config

File: startup/bl_operators/userpref.py:408

bpy.ops.preferences.keyconfig_test()¶

Test key configuration for conflicts

File: startup/bl_operators/userpref.py:167

bpy.ops.preferences.keyitem_add()¶

Add key map item

File: startup/bl_operators/userpref.py:356

bpy.ops.preferences.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: startup/bl_operators/userpref.py:388

bpy.ops.preferences.keyitem_restore(item_id=0)¶

Restore key map item

Parameters: item_id (int in [-inf, inf], (optional)) – Item Identifier, Identifier of the item to restore
File: startup/bl_operators/userpref.py:341

bpy.ops.preferences.keymap_restore(all=False)¶

Restore key map(s)

Parameters: all (boolean, (optional)) – All Keymaps, Restore all keymaps to default
File: startup/bl_operators/userpref.py:312

bpy.ops.preferences.reset_default_theme()¶: Reset to the default theme colors

bpy.ops.preferences.studiolight_copy_settings(index=0)¶

Copy Studio Light settings to the Studio Light editor

Parameters: index (int in [-inf, inf], (optional)) – index
File: startup/bl_operators/userpref.py:1095

bpy.ops.preferences.studiolight_install(files=None, directory='', filter_folder=True, filter_glob='*.png;*.jpg;*.hdr;*.exr', type='MATCAP')¶

Install a user defined light

Parameters

files (bpy_prop_collection of OperatorFileListElement, (optional)) – File Path
directory (string, (optional, never None)) – directory
filter_folder (boolean, (optional)) – Filter Folders
filter_glob (string, (optional, never None)) – filter_glob
type (enum in ['MATCAP', 'WORLD', 'STUDIO'], (optional)) –
Type
- MATCAP MatCap, Install custom MatCaps.
- WORLD World, Install custom HDRIs.
- STUDIO Studio, Install custom Studio Lights.

File

startup/bl_operators/userpref.py:976

bpy.ops.preferences.studiolight_new(filename='StudioLight')¶

Save custom studio light from the studio light editor settings

Parameters: filename (string, (optional, never None)) – Name
File: startup/bl_operators/userpref.py:1022

bpy.ops.preferences.studiolight_show()¶

Show light preferences

File: startup/bl_operators/userpref.py:1117

bpy.ops.preferences.studiolight_uninstall(index=0)¶

Delete Studio Light

Parameters: index (int in [-inf, inf], (optional)) – index
File: startup/bl_operators/userpref.py:1072

bpy.ops.preferences.theme_install(overwrite=True, filepath='', filter_folder=True, filter_glob='*.xml')¶

Load and apply a Blender XML theme file

Parameters

overwrite (boolean, (optional)) – Overwrite, Remove existing theme file if exists
filepath (string, (optional, never None)) – filepath
filter_folder (boolean, (optional)) – Filter folders
filter_glob (string, (optional, never None)) – filter_glob

File

startup/bl_operators/userpref.py:516