プラグイン

プラグインはWarudoのすべてのカスタムスクリプトの親です。また、リソースプロバイダーとリゾルバーの登録、外部サービスでの認証、プラグインのアセットおよびノードに関するグローバル設定のユーザーによる構成を可能にするなど、シーンから独立したタスクの実行にも使用されます。

ヒント

Playgroundを使用すると、プラグインを作成せずにカスタムアセットとノードを読み込めます。これらはWarudoの「Core」プラグインによって自動的に登録・管理されます。ただし、カスタムアセットとノードを他のユーザーに配布するには、独自のプラグインがそれらを登録するプラグインModを作成する必要があります。

情報

このページではプラグインを作成するためのスクリプティングAPIを説明します。プラグインModページも参照してください。

型の定義

Warudoで読み込み・実行できるプラグイン型を作成できます。プラグイン型はPlugin型を継承し、次のように[PluginType]属性で装飾します。

[PluginType(
    Id = "hakuyatira.helloworld",
    Name = "Hello World",
    Description = "A simple plugin that says hello to the world.",
    Version = "1.0.0",
    Author = "Hakuya Tira",
    Icon = null,
    SupportUrl = "https://docs.warudo.app",
    AssetTypes = new [] { typeof(HelloWorldAsset) },
    NodeTypes = new [] { typeof(HelloWorldNode) }
)]
public class HelloWorldPlugin : Plugin {
    // Plugin implementation
}

パラメーターの概要は次のとおりです。

Id: プラグイン型の一意の識別子です。逆ドメイン名表記（例: com.example.pluginname）の使用をおすすめします。プラグイン型はシングルトンであるため、そのIdプロパティ（plugin.Id）はプラグイン型のID（plugin.PluginType.Id）と同じです。
Name: プラグインの名前です。
Description: プラグインの簡単な説明です。
Version: プラグインのバージョンです。セマンティックバージョニング標準に従うことをおすすめします。
Author: プラグインの作者です。
Icon: 任意。プラグインのSVGアイコンです。この値を格納するconst stringフィールドを定義することをおすすめします。
SupportUrl: 任意。プラグインのサポートページのURLです。
AssetTypes: このプラグイン内のアセット型の配列です。
NodeTypes: このプラグイン内のノード型の配列です。

ヒント

iconは単一のSVG要素（例: <svg>...</svg>）である必要があります。例:

<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 512 512">
    <path>...</path>
</svg>

ライフサイクル

エンティティページに記載されたライフサイクル段階に加えて、プラグインには次の追加のライフサイクル段階があります。

OneTimeSetup(): Plugins/Data内にプラグインのデータファイルが存在するかどうかで判定され、Warudoがプラグインを初めて読み込むときに1回だけ呼び出されます。
OnSceneLoaded(Scene scene, SerializedScene serializedScene): すべてのアセットとノードがデシリアライズされた後、シーンが読み込まれたときに呼び出されます。
OnSceneUnloaded(Scene scene): シーンがアンロードされたときに呼び出されます。

コンポーネント

プラグイン型では、データ入力とトリガーを定義できます。

Unityアセットの読み込み

初めてのプラグインModを作成するチュートリアルで示したように、ModHostを使用してプラグインのModフォルダー内のUnityアセットを読み込めます。たとえば、プレハブを読み込むには次のようにします。

var prefab = ModHost.LoadAsset<GameObject>("Assets/MyModFolder/MyPrefab.prefab");

テキストアセット（例: JSONファイル）を読み込むには次のようにします。

var text = ModHost.LoadAsset<TextAsset>("Assets/MyModFolder/MyText.json");

ヒント

Warudoは基盤となるModフレームワークとしてuMod 2.0を使用しています。アセットの読み込みについての詳細は、ModHostドキュメントを参照してください。

ツールバーアイコン

一部の組み込みプラグインがツールバーにアイコンを表示していることに気付くかもしれません。さらに、アイコンはクリック可能で、プラグインの設定を開くために使用できます。

これを実現するには、プラグインクラスにToolbarItemMixinミックスインを含めます。

[Mixin]
public ToolbarItemMixin ToolbarItem;

private bool serverConnected; // Assume this is a field that indicates whether the plugin is connected to an external server

public override void OnCreate() {
    base.OnCreate();
    ToolbarItem.SetIcon(ToolbarIcon); // ToolbarIcon is a const string that contains a SVG icon
    ToolbarItem.OnTrigger = () => Context.Service.NavigateToPlugin(Type.Id); // Open the plugin settings when the icon is clicked
}

public override void OnUpdate() {
    base.OnUpdate();
    ToolbarItem.SetEnabled(serverConnected); // Only show the icon if connected to the server
    ToolbarItem.SetTooltip("Connected! Current time: " + DateTime.Now); // Set a tooltip that is displayed when the user hovers over the icon
}

ノードとアセットから所有プラグインにアクセスする

ノードとアセットからは、Pluginプロパティを使用して所有プラグインにアクセスできます。例:

public override void OnCreate() {
    base.OnCreate();
    var myPlugin = (HelloWorldPlugin) Plugin;
    // Do something with myPlugin
}