プラグインの作成¶

プラグインについて¶

プラグインは、便利なツールを使用してエディタを拡張する優れた方法です。エディタをリロードしなくても、GDScriptと標準シーンで完全に作成できます。モジュールとは異なり、C++コードを作成したり、エンジンを再コンパイルしたりする必要はありません。これによりプラグインのパワフルさが低下しますが、プラグインでできることはまだたくさんあります。プラグインは、エディタ機能を追加するスクリプトを使用して作成されることを除いて、すでに作成できるシーンに似ていることに注意してください。

このチュートリアルでは、2つの単純なプラグインを作成する手順を説明します。プラグインの動作を理解し、独自のプラグインを開発できるようになります。1つはプロジェクトの任意のシーンに追加できるカスタムノードで、もう1つはエディタに追加されるカスタムドックです。

プラグインの作成¶

開始する前に、必要な場所に新しい空のプロジェクトを作成します。これは、プラグインを開発およびテストするためのベースとして機能します。

エディタが新しいプラグインを識別するために最初に必要なことは、設定用の plugin.cfg と機能を備えたツールスクリプトの2つのファイルを作成することです。プラグインには、プロジェクトフォルダ内に addons/plugin_name のような標準パスがあります。Godotは、これらのファイルを生成し、必要な場所に配置するためのダイアログを提供します。

メインツールバーで、[プロジェクト]ドロップダウンをクリックします。次に、[プロジェクト設定...]をクリックします。[プラグイン]タブに移動し、右上の[作成]ボタンをクリックします。

次のようなダイアログが表示されます:

../../../_images/making_plugins-create_plugin_dialog.png

各フィールドのプレースホルダーテキストは、プラグインによるファイルの作成と構成ファイルの値にどのように影響するかを説明しています。

To continue with the example, use the following values:

Plugin Name: My Custom Node
Subfolder: my_custom_node
Description: A custom node made to extend the Godot Engine.
Author: Your Name Here
Version: 1.0.0
Language: GDScript
Script Name: custom_node.gd
Activate now: No

Plugin Name: My Custom Node
Subfolder: my_custom_node
Description: A custom node made to extend the Godot Engine.
Author: Your Name Here
Version: 1.0.0
Language: C#
Script Name: CustomNode.cs
Activate now: No

警告

Unchecking the Activate now? option in C# is always required because, like every other C# script, the EditorPlugin script needs to be compiled which requires building the project. After building the project the plugin can be enabled in the Plugins tab of Project Settings.

次のようなディレクトリ構造になるはずです:

../../../_images/making_plugins-my_custom_mode_folder.png

``plugin.cfg``は、プラグインに関するメタデータを持つシンプルなINIファイルです。名前と説明は、人々の理解を助けるものです。あなたの名前はあなたがあなたの仕事に対して適切に認められるのに役立ちます。バージョン番号は、他の人が古いバージョンであるかどうかを知るのに役立ちます。バージョン番号を見つける方法がわからない場合は、Semantic Versioning を確認してください。メインスクリプトファイルは、プラグインがアクティブになると、プラグインがエディタで行うことをGodotに指示します。

スクリプトファイル¶

プラグインの作成時に、ダイアログが自動的にEditorPluginスクリプトを開きます。スクリプトには、変更できない2つの要件があります: まず tool スクリプトである必要があります。そうでない場合、エディタに適切にロードされされません。次に EditorPlugin を継承する必要があります。

警告

In addition to the EditorPlugin script, any other script that your plugin uses must also be a tool. * Any GDScript without tool imported into the editor will act like an empty file! * Any C# class without [Tool] won't be reloaded when the project is built forcing you to re-enable the plugin!

リソースの初期化とクリーンアップに対処することが重要です。仮想関数 _enter_tree() を使用してプラグインを初期化し、_exit_tree() を使用してクリーンアップすることをお勧めします。ありがたいことに、ダイアログはこれらのコールバックを生成します。スクリプトは次のようになります:

tool
extends EditorPlugin


func _enter_tree():
    # Initialization of the plugin goes here.
    pass


func _exit_tree():
    # Clean-up of the plugin goes here.
    pass

#if TOOLS
using Godot;
using System;

[Tool]
public class CustomNode : EditorPlugin
{
    public override void _EnterTree()
    {
        // Initialization of the plugin goes here.
    }

    public override void _ExitTree()
    {
        // Clean-up of the plugin goes here.
    }
}
#endif

これは、新しいプラグインを作成するときに使用するのに適したテンプレートです。

カスタムノード¶

再利用可能なカスタムシーンやコントロールなど、多くのノードで特定の動作が必要な場合があります。インスタンス化は多くの場合に役立ちますが、多くのプロジェクトでインスタンス化を使用している場合は特に、面倒な場合があります。これに対する適切な解決策は、カスタムの動作を持つノードを追加するプラグインを作成することです。

警告

Nodes added via an EditorPlugin are "CustomType" nodes. While they work with any scripting language, they have fewer features than the Script Class system. If you are writing GDScript or NativeScript, we recommend using Script Classes instead.

新しいノードタイプを作成するには、EditorPlugin クラスの関数 add_custom_type() を使用できます。この関数は、新しいタイプのエディタ(ノードまたはリソース)を追加できます。ただし、タイプを作成する前に、タイプのロジックとして機能するスクリプトが必要です。このスクリプトは tool キーワードを使用する必要はありませんが、スクリプトをエディタで実行させるためにそれを追加できます。

このチュートリアルでは、クリックされたときにメッセージを印刷する簡単なボタンを作成します。そのためには、Button から拡張する簡単なスクリプトが必要です。必要に応じて BaseButton を拡張することもできます:

tool
extends Button


func _enter_tree():
    connect("pressed", self, "clicked")


func clicked():
    print("You clicked me!")

using Godot;
using System;

[Tool]
public class MyButton : Button
{
    public override void _EnterTree()
    {
        Connect("pressed", this, "clicked");
    }

    public void clicked()
    {
        GD.Print("You clicked me!");
    }
}

基本的なボタンはこれで終わりです。これをプラグインフォルダ内に my_button.gd として保存できます。シーンツリーに表示するには、16×16アイコンも必要です。持っていない場合は、デフォルトのものをエンジンから取得して、addons/my_custom_node フォルダに icon.png として保存するか、デフォルトのGodotロゴ(preload("res://icon.png"))を使用します。必要に応じて、SVGアイコンを使用することもできます。

次に、**Nodeを新規作成 ** ダイアログに表示されるように、カスタムタイプとして追加する必要があります。そのためには、custom_node.gd スクリプトを次のように変更します:

tool
extends EditorPlugin


func _enter_tree():
    # Initialization of the plugin goes here.
    # Add the new type with a name, a parent type, a script and an icon.
    add_custom_type("MyButton", "Button", preload("my_button.gd"), preload("icon.png"))


func _exit_tree():
    # Clean-up of the plugin goes here.
    # Always remember to remove it from the engine when deactivated.
    remove_custom_type("MyButton")

#if TOOLS
using Godot;
using System;

[Tool]
public class CustomNode : EditorPlugin
{
    public override void _EnterTree()
    {
        // Initialization of the plugin goes here.
        // Add the new type with a name, a parent type, a script and an icon.
        var script = GD.Load<Script>("MyButton.cs");
        var texture = GD.Load<Texture>("icon.png");
        AddCustomType("MyButton", "Button", script, texture);
    }

    public override void _ExitTree()
    {
        // Clean-up of the plugin goes here.
        // Always remember to remove it from the engine when deactivated.
        RemoveCustomType("MyButton");
    }
}
#endif

これが完了すると、プラグインは プロジェクト設定 のプラグインリストですでに使用可能になっているはずなので、Checking the results で説明されているようにアクティブにします。

次に、新しいノードを追加して試してください:

../../../_images/making_plugins-custom_node_create.png

ノードを追加すると、作成したスクリプトが既に接続されていることがわかります。ボタンにテキストを設定し、シーンを保存して実行します。ボタンをクリックすると、コンソールにテキストが表示されます:

../../../_images/making_plugins-custom_node_console.png

カスタムドック¶

場合によっては、エディタを拡張し、常に使用可能なツールを追加する必要があります。簡単な方法は、新しいドックにプラグインを追加することです。ドックはコントロールに基づいた単なるシーンであるため、通常のGUIシーンと同様の方法で作成されます。

カスタムドックの作成は、カスタムノードのように行われます。addons/my_custom_dock フォルダに新しい plugin.cfg ファイルを作成し、次のコンテンツを追加します:

[plugin]

name="My Custom Dock"
description="A custom dock made so I can learn how to make plugins."
author="Your Name Here"
version="1.0"
script="custom_dock.gd"

[plugin]

name="My Custom Dock"
description="A custom dock made so I can learn how to make plugins."
author="Your Name Here"
version="1.0"
script="CustomDock.cs"

に、同じフォルダにスクリプト custom_dock.gd を作成します。良いスタートを切るために、:ref:`前に見たテンプレート <doc_making_plugins_template_code> ` を入力してください。

新しいカスタムドックを追加しようとしているので、ドックのコンテンツを作成する必要があります。これは、標準のGodotシーンに他なりません。エディタで新しいシーンを作成し、編集するだけです。

エディタドックの場合、ルートノードは必ず Control またはその子クラスでなければなりません。このチュートリアルでは、1つのボタンを作成できます。ルートノードの名前は、ドックタブに表示される名前でもあるため、必ず短くわかりやすい名前を付けてください。また、ボタンにテキストを追加することを忘れないでください。

../../../_images/making_plugins-my_custom_dock_scene.png

このシーンを my_dock.tscn として保存します。次に、作成したシーンを取得し、エディタでドックとして追加する必要があります。このために、EditorPlugin クラスの関数 add_control_to_dock() を使用できます。

ドックの位置を選択し、追加するコントロール(作成したばかりのシーン)を定義する必要があります。プラグインが非アクティブになったら、ドックを削除する ことを忘れないでください。スクリプトは次のようになります:

tool
extends EditorPlugin


# A class member to hold the dock during the plugin life cycle.
var dock


func _enter_tree():
    # Initialization of the plugin goes here.
    # Load the dock scene and instance it.
    dock = preload("res://addons/my_custom_dock/my_dock.tscn").instance()

    # Add the loaded scene to the docks.
    add_control_to_dock(DOCK_SLOT_LEFT_UL, dock)
    # Note that LEFT_UL means the left of the editor, upper-left dock.


func _exit_tree():
    # Clean-up of the plugin goes here.
    # Remove the dock.
    remove_control_from_docks(dock)
    # Erase the control from the memory.
    dock.free()

#if TOOLS
using Godot;
using System;

[Tool]
public class CustomDock : EditorPlugin
{
    Control dock;

    public override void _EnterTree()
    {
        dock = (Control)GD.Load<PackedScene>("addons/my_custom_dock/my_dock.tscn").Instance();
        AddControlToDock(DockSlot.LeftUl, dock);
    }

    public override void _ExitTree()
    {
        // Clean-up of the plugin goes here.
        // Remove the dock.
        RemoveControlFromDocks(dock);
        // Erase the control from the memory.
        dock.Free();
    }
}
#endif

ドックは指定された位置に最初に表示されますが、ユーザーは自由に位置を変更し、結果のレイアウトを保存できることに注意してください。

結果の確認¶

ここで、作業の結果を確認します。プロジェクト設定 を開き、プラグイン タブをクリックします。プラグインはリストにある唯一のものでなければなりません。表示されていない場合は、右上隅の[アップデート]ボタンをクリックします。

../../../_images/making_plugins-project_settings.png

ステータス 列でプラグインが非アクティブであることを確認できます。ステータスをクリックして[Active]を選択します。設定ウィンドウを閉じる前に、ドックが表示されるはずです。これで、カスタムドックができました:

../../../_images/making_plugins-custom_dock.png

今後の展開¶

基本的なプラグインの作成方法を学習したので、エディタをいくつかの方法で拡張できます。GDScriptを使用して、多くの機能をエディタに追加できます。これは、C++モジュールを詳しく掘り下げることなく、専用のエディタを作成するための強力な方法です。

自分でプラグインを作成して自分自身を助け、Asset Library で共有して、人々があなたの仕事から利益を得られるようにすることができます。

Registering autoloads/singletons in plugins¶

It is possible for editor plugins to automatically register autoloads when the plugin is enabled. This also includes unregistering the autoload when the plugin is disabled.

This makes setting up plugins faster for users, as they no longer have to manually add autoloads to their project settings if your editor plugin requires the use of an autoload.

Use the following code to register a singleton from an editor plugin:

tool
extends EditorPlugin

# Replace this value with a PascalCase autoload name, as per the GDScript style guide.
const AUTOLOAD_NAME = "SomeAutoload"


func _enter_tree():
    # The autoload can be a scene or script file.
    add_autoload_singleton(AUTOLOAD_NAME, "res://addons/my_addon/some_autoload.tscn")


func _exit_tree():
    remove_autoload_singleton(AUTOLOAD_NAME)

プラグインの作成¶

プラグインについて¶