C++のカスタムモジュール

モジュール

Godotでは、モジュール方式でエンジンを拡張できます。新しいモジュールを作成してから、有効/無効にすることができます。これにより、コアを変更せずにすべてのレベルで新しいエンジン機能を追加できます。コアは別のモジュールで使用および再利用するために分割できます。

モジュールは、ビルド システムの modules/ サブディレクトリにあります。デフォルトでは、GDScript(これは基本エンジンの一部ではない)、Mono ランタイム、正規表現モジュールなど、多くの異なるモジュールが存在します。必要に応じて多くの新しいモジュールを作成して組み合わせることができ、SConsビルドシステムが透過的に使用します。

何のために?

ゲームの大部分はスクリプトで記述することをお勧めしますが(時間を大幅に節約できるため)、代わりに完全にC++を使用することも可能です。 C++モジュールの追加は、次のシナリオで役立ちます:

  • 外部ライブラリをGodot にバインドする(PhysX、FMODなど)。
  • ゲームの重要な部分を最適化します。
  • エンジンまたはエディタに新しい機能を追加します。
  • 既存のゲームを移植します。
  • C++なしでは生きていけないので、C++で新しいゲームを書きます。

新しいモジュールの作成

モジュールを作成する前に、Godot のソースコードをダウンロードし、コンパイルに成功してください。このドキュメントにはチュートリアルがあります。

新しいモジュールを作成するには、最初のステップは modules/ 内にディレクトリを作成することです。モジュールを個別に保守する場合は、別のVCSをモジュールにチェックアウトして使用できます。

例のモジュールは「summator」と呼ばれ、Godot ソースツリー内に配置されます( C:\godot は Godot ソースが配置されている場所を指します):

C:\godot> cd modules
C:\godot\modules> mkdir summator
C:\godot\modules> cd summator
C:\godot\modules\summator>

内部では、単純なsummatorクラスを作成します:

/* summator.h */

#ifndef SUMMATOR_H
#define SUMMATOR_H

#include "core/reference.h"

class Summator : public Reference {
    GDCLASS(Summator, Reference);

    int count;

protected:
    static void _bind_methods();

public:
    void add(int p_value);
    void reset();
    int get_total() const;

    Summator();
};

#endif // SUMMATOR_H

それからcppファイル。

/* summator.cpp */

#include "summator.h"

void Summator::add(int p_value) {
    count += p_value;
}

void Summator::reset() {
    count = 0;
}

int Summator::get_total() const {
    return count;
}

void Summator::_bind_methods() {
    ClassDB::bind_method(D_METHOD("add", "value"), &Summator::add);
    ClassDB::bind_method(D_METHOD("reset"), &Summator::reset);
    ClassDB::bind_method(D_METHOD("get_total"), &Summator::get_total);
}

Summator::Summator() {
    count = 0;
}

次に、新しいクラスを何らかの方法で登録する必要があるので、さらに2つのファイルを作成する必要があります:

register_types.h
register_types.cpp

次の内容を使用します:

/* register_types.h */

void register_summator_types();
void unregister_summator_types();
/* yes, the word in the middle must be the same as the module folder name */
/* register_types.cpp */

#include "register_types.h"

#include "core/class_db.h"
#include "summator.h"

void register_summator_types() {
    ClassDB::register_class<Summator>();
}

void unregister_summator_types() {
   // Nothing to do here in this example.
}

次に、ビルドシステムがこのモジュールをコンパイルできるように SCsub ファイルを作成する必要があります:

# SCsub

Import('env')

env.add_source_files(env.modules_sources, "*.cpp") # Add all cpp files to the build

複数のソースを使用して、各ファイルをPython文字列リストに個別に追加することもできます:

src_list = ["summator.cpp", "other.cpp", "etc.cpp"]
env.add_source_files(env.modules_sources, src_list)

これにより、Pythonを使ってループと論理ステートメントを利用してファイルリストを作成できる強力な可能性が実現されます。例として、デフォルトでGodotに同梱されている他のモジュールをいくつか見てください。

コンパイラが見るインクルードディレクトリを追加するには、環境のパスに追加します:

env.Append(CPPPATH=["mylib/include"]) # this is a relative path
env.Append(CPPPATH=["#myotherlib/include"]) # this is an 'absolute' path

モジュールのビルド時にカスタムコンパイラフラグを追加する場合は、最初に env のクローンを作成する必要があるので、これらのフラグはGodotビルド全体に追加されません(エラーが発生する可能性があります)。カスタムフラグを使用した SCsub の例:

# SCsub

Import('env')

module_env = env.Clone()
module_env.add_source_files(env.modules_sources, "*.cpp")
module_env.Append(CCFLAGS=['-O2']) # Flags for C and C++ code
module_env.Append(CXXFLAGS=['-std=c++11']) # Flags for C++ code only

最後に、モジュールの構成ファイルは、 config.py という名前を付けなければならない単純なPythonスクリプトです:

# config.py

def can_build(env, platform):
    return True

def configure(env):
    pass

モジュールは、特定のプラットフォーム用にビルドしてもよいかどうかを尋ねられます(この場合、True はすべてのプラットフォーム用にビルドすることを意味します)。

以上です。あまり複雑でなければいいのですが。モジュールは次のようになります:

godot/modules/summator/config.py
godot/modules/summator/summator.h
godot/modules/summator/summator.cpp
godot/modules/summator/register_types.h
godot/modules/summator/register_types.cpp
godot/modules/summator/SCsub

その後、それを圧縮し、他の人とモジュールを共有することができます。すべてのプラットフォーム (前のセクションの手順)を構築する場合は、モジュールが含まれます。

注釈

サブクラスなどのC++モジュールには、パラメーター数が5までの制限があります。これは、ヘッダーファイル core/method_bind_ext.gen.inc を含めることで13に上げることができます。

モジュールの使用

これで、任意のスクリプトから新しく作成したモジュールを使用できます:

var s = Summator.new()
s.add(10)
s.add(20)
s.add(30)
print(s.get_total())
s.reset()

出力は 60 になります。

参考

前のSummatorの例は、小さなカスタムモジュールに最適ですが、より大きな外部ライブラリを使用する場合はどうでしょうか。外部ライブラリへのバインドの詳細については、外部ライブラリへのバインド を参照してください。

警告

モジュールが(エディタからだけでなく)実行中のプロジェクトからアクセスされる場合、使用する予定のすべてのエクスポートテンプレートを再コンパイルし、各エクスポートプリセットでカスタムテンプレートへのパスを指定する必要があります。そうしないと、モジュールがエクスポートテンプレートでコンパイルされないため、プロジェクトの実行時にエラーが発生します。詳細については、Compiling ページを参照してください。

Customizing module types initialization

Modules can interact with other built-in engine classes during runtime and even affect the way core types are initialized. So far, we've been using register_summator_types as a way to bring in module classes to be available within the engine.

A crude order of the engine setup can be summarized as a list of the following type registration methods:

preregister_module_types();
preregister_server_types();
register_core_singletons();
register_server_types();
register_scene_types();
EditorNode::register_editor_types();
register_platform_apis();
register_module_types();
initialize_physics();
initialize_navigation_server();
register_server_singletons();
register_driver_types();
ScriptServer::init_languages();

Our Summator class is initialized during the register_module_types() call. Imagine that we need to satisfy some common module run-time dependency (like singletons), or allow us to override existing engine method callbacks before they can be assigned by the engine itself. In that case, we want to ensure that our module classes are registered before any other built-in type.

This is where we can define an optional preregister_summator_types() method which will be called before anything else during the preregister_module_types() engine setup stage.

We now need to add this method to register_types header and source files:

/* register_types.h */

#define MODULE_SUMMATOR_HAS_PREREGISTER
void preregister_summator_types();

void register_summator_types();
void unregister_summator_types();

注釈

Unlike other register methods, we have to explicitly define MODULE_SUMMATOR_HAS_PREREGISTER to let the build system know what relevant method calls to include at compile time. The module's name has to be converted to uppercase as well.

/* register_types.cpp */

#include "register_types.h"

#include "core/class_db.h"
#include "summator.h"

void preregister_summator_types() {
    // Called before any other core types are registered.
    // Nothing to do here in this example.
}

void register_summator_types() {
    ClassDB::register_class<Summator>();
}

void unregister_summator_types() {
   // Nothing to do here in this example.
}

開発のためのビルドシステムの改善

ここまでは、Godotバイナリの一部として新しいモジュールのソースを追加できるクリーンでシンプルなSCsubを定義しました。

この静的なアプローチは、すべてのモジュールを1つのバイナリにしたい場合に、ゲームのリリースバージョンを構築したいときに適しています。

ただし、トレードオフは、すべての変更がゲームの完全な再コンパイルを意味することです。 SConsが変更されたファイルのみを検出して再コンパイルできたとしても、そのようなファイルを見つけて最終的に最終的なバイナリをリンクすることは長くてコストのかかる部分です。

このようなコストを回避するソリューションは、ゲームのバイナリを起動するときに動的に読み込まれる共有ライブラリとして独自のモジュールを構築することです。

# SCsub

Import('env')

sources = [
    "register_types.cpp",
    "summator.cpp"
]

# First, create a custom env for the shared library.
module_env = env.Clone()
module_env.Append(CCFLAGS=['-fPIC'])  # Needed to compile shared library
# We don't want godot's dependencies to be injected into our shared library.
module_env['LIBS'] = []

# Now define the shared library. Note that by default it would be built
# into the module's folder, however it's better to output it into `bin`
# next to the Godot binary.
shared_lib = module_env.SharedLibrary(target='#bin/summator', source=sources)

# Finally notify the main env it has our shared lirary as a new dependency.
# To do so, SCons wants the name of the lib with it custom suffixes
# (e.g. ".x11.tools.64") but without the final ".so".
# We pass this along with the directory of our library to the main env.
shared_lib_shim = shared_lib[0].name.rsplit('.', 1)[0]
env.Append(LIBS=[shared_lib_shim])
env.Append(LIBPATH=['#bin'])

コンパイルしたら、 godot* バイナリと libsummator* .so の両方を含む bin ディレクトリになります。 ただし、「.so」が標準ディレクトリ( /usr/lib など)にない場合、 LD_LIBRARY_PATH 環境変数を使用して、実行時にバイナリを見つける必要があります:

user@host:~/godot$ export LD_LIBRARY_PATH=`pwd`/bin/
user@host:~/godot$ ./bin/godot*

: environ変数を export する必要があることに注意してください。そうしないと、エディタ内からプロジェクトを再生できなくなります。

さらに、モジュールを共有ライブラリとして(開発用)コンパイルするか、Godotバイナリの一部として(リリース用)コンパイルするかを選択できると便利です。それには、ARGUMENT コマンドを使用してSConsに渡すカスタムフラグを定義できます:

# SCsub

Import('env')

sources = [
    "register_types.cpp",
    "summator.cpp"
]

module_env = env.Clone()
module_env.Append(CCFLAGS=['-O2'])
module_env.Append(CXXFLAGS=['-std=c++11'])

if ARGUMENTS.get('summator_shared', 'no') == 'yes':
    # Shared lib compilation
    module_env.Append(CCFLAGS=['-fPIC'])
    module_env['LIBS'] = []
    shared_lib = module_env.SharedLibrary(target='#bin/summator', source=sources)
    shared_lib_shim = shared_lib[0].name.rsplit('.', 1)[0]
    env.Append(LIBS=[shared_lib_shim])
    env.Append(LIBPATH=['#bin'])
else:
    # Static compilation
    module_env.add_source_files(env.modules_sources, sources)

現在、デフォルトで scons コマンドは、モジュールをGodotのバイナリの一部として、そして summator_shared = yes を渡すときに共有ライブラリとしてビルドします。

最後に、共有モジュールを scons コマンドのターゲットとして明示的に指定することで、ビルドをさらに高速化することもできます:

user@host:~/godot$ scons summator_shared=yes platform=x11 bin/libsummator.x11.tools.64.so

カスタムドキュメントの作成

ドキュメントを書くのは退屈な作業のように思えるかもしれませんが、ユーザーが役立てやすくするために、新しく作成したモジュールを文書化することを強くお勧めします。1年前に書いたコードは、他の人が書いたコードと区別がつかないかもしれないので、将来の自分に親切にしてください!

モジュールのカスタムドキュメントをセットアップするには、いくつかの手順があります:

  1. モジュールのルートに新しいディレクトリを作成します。ディレクトリ名は何でもかまいませんが、このセクションでは doc_classes という名前を使用します。

  2. 次のコードスニペットを config.py に追加します:

    def get_doc_classes():
        return [
            "ClassName",
        ]
    
    def get_doc_path():
        return "doc_classes"
    

get_doc_classes() メソッドは、モジュールに複数のクラスが含まれている可能性があるため、モジュールのどのドキュメントクラスをマージする必要があるかをビルドシステムが知るために必要です。 ClassName をドキュメントを作成するクラスの名前に置き換えます。複数のクラスのドキュメントが必要な場合は、追加します。

get_doc_path() メソッドは、ドキュメントの場所を決定するためにビルド システムで使用されます。この例では、 doc_classes ディレクトリに配置されます。

  1. コマンドの実行:

    godot --doctool <path>
    

これは、指定された <path> へのエンジンAPIリファレンスをXML形式でダンプします。 Godotの実行可能ファイルを見つけるために PATH を設定し、書き込みアクセス権があることを確認する必要があることに注意してください。 そうでない場合は、次のようなエラーが発生する可能性があります:

ERROR: Can't write doc file: docs/doc/classes/@GDScript.xml
   At: editor/doc/doc_data.cpp:956
  1. godot/doc/classes/ClassName.xml から生成されたドキュメントファイルを取得します
  2. このファイルを doc_classes にコピーし、オプションで編集してからエンジンをコンパイルします。

ビルドシステムは、 doc_classes ディレクトリからドキュメントファイルをフェッチし、基本型とマージします。コンパイルプロセスが完了すると、ドキュメントはエンジンの組み込みドキュメントシステム内でアクセスできるようになります。

ドキュメントを最新の状態に保つために必要なことは、単に ClassName.xml ファイルの1つを変更し、エンジンを再コンパイルすることだけです。

カスタムエディタアイコンの追加

モジュール内で自己完結型のドキュメントを作成する方法と同様に、エディタに表示されるクラスの独自のカスタムアイコンを作成することもできます。

エンジン内に統合されるエディタアイコンを作成する実際のプロセスについては、最初に エディタアイコン を参照してください。

アイコンを作成したら、次の手順に進みます:

  1. icons という名前のモジュールのルートに新しいディレクトリを作成します。これは、モジュールのエディタアイコンを検索するエンジンのデフォルトパスです。
  2. 新しく作成した svg アイコン(最適化されているかどうかに関係なく)をそのフォルダに移動します。
  3. エンジンを再コンパイルし、エディタを実行します。必要に応じて、エディタのインターフェースにアイコンが表示されます。

モジュール内の別の場所にアイコンを保存したい場合は、次のコードスニペットを config.py に追加してデフォルトパスをオーバーライドします:

def get_icons_path():
    return "path/to/icons"

まとめ

覚えておいてください:

  • 継承に GDCLASS マクロを使用するので、Godotはそれをラップできます
  • 関数をスクリプトにバインドし、シグナルのコールバックとして機能できるようにするには、 _bind_methods を使用します。

しかし、これはすべてではありません、あなたが何をするかに応じて、いくつかの(うまくいけば肯定的な)驚きで迎えられます。

  • class_Node (またはSpriteなどの派生ノードタイプ) から継承すると、新しいクラスがエディタに表示され、「ノードの追加」ダイアログボックスの継承ツリーに表示されます。
  • class_Resourceから継承すると、リソース リストに表示され、公開されているすべてのプロパティは、保存/読み込み時にシリアル化できます。
  • この同じロジックによって、エディタとエンジンのほぼすべての領域を拡張できます。