Dev:RU/2.5/Py/Scripts/Addons

Дополнения

Требования к скриптам

Для того, чтобы ваши скрипты показывались вна панели Add-Ons, вы должны написать, как минимум, две функции:

• функция register
• функция unregister

Функция register вызывается когда пользователь включает дополнение, а функция unregister, когда он его отключает. Так что функция register должна содержать объявление любых операторов, панелей, меню, заголовков и свойств, а функция unregister должна это все удалять. Например:

def register():
    bpy.types.register(MyOperator)
    bpy.types.INFO_MT_mesh_add.append(my_menu_function)

def unregister():
    bpy.types.unregister(MyOperator)
    bpy.types.INFO_MT_mesh_add.remove(my_menu_function)

if __name__ == "__main__":
    register()

Последние две строки необязательны и нужны в том случае, если скрипт предполагается запускаемым не только путем его вызова его из панели Дополнений, но и вручную из текстового редактора.

Параметры скриптов

В то время как для дополнений обязательны только регистрирующие функции, есть еще несколько интересных дополнительных параметров. Рекомендуется включать по крайней мере параметры 'name', 'version', 'blender' и 'category' в ваши скрипты. Вот пример всех доступных параметров:

bl_addon_info = {
    "name": "My Script",
    "author": "John Doe, Jane Doe",
    "version": "1.0 2010/01/23",
    "blender": "2.5.2",
    "category": "Add mesh",
    "location": "View3D > Add > Mesh",
    "url": "http://wiki.blender.org/index.php/Extensions:2.5/Py/Scripts/My_Script",
    "doc": """\
Короткий параграф, который объясняет, что точно делает скрипт.

Основная часть справки может включать инструкции как использовать скрипт
и содержать советы и хитрости по использованию.
"""}

'name' (тип: string)

Название скрипта. Оно будет отображаться в меню дополнений как главная точка входа.

'author' (тип: string)

Имя автора (авторов).

'version' (тип: string)

Версия скрипта. Хорошей рекомендацией является использование номера версии и следом дату в формате YYYY/MM/DD. Например: 1.0 2010/01/23

'blender' (тип: string)

Минимальная версия Blender'а, необходимая для запуска скрипта. В панели дополнений это используется для проверки совместимости пользовательской версии Blender'а и скрипта. Если версия новее, то скрипт будет включен.

'category' (тип: string)

Определяет группу, к которой принадлежит скрипт. Это используется для фильтрации в панели дополнений.

'location' (тип: string)

Объясняет, где могут быть найдены новые функциональные возможности. Например: "View3D > Properties > Measure"

'url' (тип: string)

Ссылка на домашнюю страничку скрипта. Для включения в Blender это должна быть ссылка на Wiki-страницу скрипта (что фактически советуется для всех скриптов).

'doc' (тип: string)

Главный справочный текст. При написании первый короткий параграф должен объяснять, что скрипт делает, остальные содержат основную часть текста помощи.

Смотрите также

На странице дополнений мы собираем информацию об общем использовании дополнений.