Addon Utils

Addon Utils#

How it works and usage examples#

We use the Register utility class from the addon_utils submodule to access different decorators that will add functionality and register/unregister the decorated classes automatically for us.

from ..addon_utils import Register

With the Register utility class we can register classes from these Blender types:

  • Operator

  • Panel

  • Menu

  • AddonPreferences

  • PropertyGroup

  • WorkspaceTool

Also it includes some wrappers and helpers to help us with:

  • Property Definitions

  • Register Shorcuts (Keymaps)

  • RNA Subscriptions (wrapper for Blender’s msgbus submodule)

  • Timers (wrapper for Blender’s bpy.app.timers submodule)

  • UI appends (to insert custom UI components into any Blender Python defined layout)

  • UI overrides (to override built-in Blender UI classes methods)

See more in the source at addon_utils/register/__init__.py

[ Examples can be found in the examples folder ]#

Contents