コンテンツにスキップ

EAUploader.Editor.Plugin.API

拡張機能(プラグイン)の登録に関わる公開APIです。 Editor/Public EAUploader API/EAUploader.Editor.Plugin.API.csで定義されています。

using EAUploader.Editor.Plugin.API;
ClassDescription
PluginAPIプラグイン関連の公開APIを提供するクラス
PluginAPI.EditorRegistrationエディタの登録情報を表すクラス
PluginAPI.EAUPluginAttributeプラグインの初期化メソッドを指定するための属性

PluginAPI


MethodTypeDescription
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と同じ働きをします。登録したエディタは、セットアップタブの「編集ツール」に表示されます。
  • OnEditorManagerLoadは、EAUploaderの起動時に呼び出される処理です。通常、拡張機能から呼び出す必要はありません。

PluginAPI.EditorRegistration


PropertyTypeDescription
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",
});
}
}