KeyConfigurations(bpy_prop_collection)

base classes — bpy_prop, bpy_prop_collection

class bpy.types.KeyConfigurations(bpy_prop_collection)

Collection of KeyConfigs

active

Active key configuration (preset)

Type:

KeyConfig

addon

Key configuration that can be extended by add-ons, and is added to the active configuration when handling events (readonly)

Type:

KeyConfig

default

Default builtin key configuration (readonly)

Type:

KeyConfig

user

Final key configuration that combines keymaps from the active and add-on configurations, and can be edited by the user (readonly)

Type:

KeyConfig

new(name)

new

Parameters:

name (str) – Name, (never None)

Returns:

Key Configuration, Added key configuration

Return type:

KeyConfig

remove(keyconfig)

remove

Parameters:

keyconfig (KeyConfig) – Key Configuration, Removed key configuration (never None)

find_item_from_operator(idname, *, context='INVOKE_DEFAULT', properties=None, include={'ACTIONZONE', 'KEYBOARD', 'MOUSE', 'NDOF'}, exclude=set())

find_item_from_operator

Parameters:
Returns:

keymap, KeyMap

item, KeyMapItem

Return type:

tuple[KeyMap, KeyMapItem]

update(*, keep_properties=False)

update

Parameters:

keep_properties (bool) – Keep Properties, Operator properties are kept to allow the operators to be registered again in the future (optional)

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References