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

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

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

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

bpy.ops.preferences.addon_refresh()¶

Scan add-on directories for new modules

File: startup/bl_operators/userpref.py:569

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

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

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

bpy.ops.preferences.copy_prev()¶

Copy settings from previous version

File: startup/bl_operators/userpref.py:152

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

Undocumented, consider contributing.

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

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

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

bpy.ops.preferences.keyconfig_remove()¶

Remove key config

File: startup/bl_operators/userpref.py:417

bpy.ops.preferences.keyconfig_test()¶

Test key-config for conflicts

File: startup/bl_operators/userpref.py:176

bpy.ops.preferences.keyitem_add()¶

Add key map item

File: startup/bl_operators/userpref.py:365

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

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 remove
File: startup/bl_operators/userpref.py:350

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

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

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

Install a user defined studio 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

File

startup/bl_operators/userpref.py:982

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

bpy.ops.preferences.studiolight_show()¶

Show light preferences

File: startup/bl_operators/userpref.py:1123

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

Delete Studio Light

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

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