跳转到内容

EAUploader.Editor.Plugin.API

与扩展功能(插件)注册相关的公开API。 定义在Editor/Public EAUploader API/EAUploader.Editor.Plugin.API.cs中。

using EAUploader.Editor.Plugin.API;
类说明
PluginAPI提供与插件相关的公开API
PluginAPI.EditorRegistration表示编辑器注册信息
PluginAPI.EAUPluginAttribute用于指定插件初始化方法的特性

PluginAPI


方法类型说明
OnEditorRegisteredEvent注册新编辑器时触发
OnEditorManagerLoadVoid加载(初始化)编辑器管理器
RegisterEditorVoid注册新的编辑器
GetRegisteredEditorsIEnumerable获取已注册编辑器的列表
public static event EAUploaderEditorManager.EditorRegisteredHandler OnEditorRegistered;
public static void OnEditorManagerLoad();
public static void RegisterEditor(PluginAPI.EditorRegistration editorRegistration);
public static IEnumerable<PluginAPI.EditorRegistration> GetRegisteredEditors();
  • RegisterEditor与EAUploaderEditorManager.RegisterEditor作用相同。已注册的编辑器会显示在编辑界面的”Edit tool”中。
  • OnEditorManagerLoad是EAUploader启动时调用的处理。扩展功能通常无需调用。

PluginAPI.EditorRegistration


属性类型说明
MenuNameString按下按钮时执行的菜单路径
EditorNameString编辑工具列表中显示的名称
DescriptionString说明
VersionString版本
AuthorString作者
UrlString支持页面等的URL
RequirementFunc<string, bool>判断编辑器是否可用的方法。参数为所选预制体的路径
RequirementDescriptionString编辑器不可用时显示的消息

各属性的详细内容请参阅”快速入门指南”。

PluginAPI.EAUPluginAttribute


用于指定插件初始化方法的特性。

using EAUploader;
using EAUploader.Editor.Plugin.API;
public static class MyPlugin
{
[EAUPlugin] // EAUploader.EAUPluginAttribute
private static void Initialize()
{
PluginAPI.RegisterEditor(new PluginAPI.EditorRegistration
{
MenuName = "Tools/My Avatar Tool",
EditorName = "My Avatar Tool",
Description = "Description of my tool",
Version = "0.1.0",
Author = "Your Name",
});
}
}