BLOGブログ

2014.08.28UE4UE/ C++

[UE4] C++コードにゲームの初期化,終了,更新のタイミングで処理を追加する方法

改訂バージョン: Unreal Engine 4.21

UE4のC++コードプロジェクトを利用していると、レベルに依存しない初期化、後処理、毎フレームの更新を行いたいケースが出てくるのではないかと思います。

今回は、その記述方法をご紹介します。

 

1.ゲームモジュールの初期化と開放

C++コードを含むプロジェクトを作成すると、プロジェクト名と同名のcppファイルが自動生成されます。

今回は「MyCodeProject」という名前で解説を進めたいと思います。

 

MyCodeProject.cpp の内容は、デフォルトでは下記のようになっています。

IMPLEMENT_PRIMARY_GAME_MODULE( FDefaultGameModuleImpl, MyCodeProject, “MyCodeProject” );

この4行目の IMPLEMENT_PRIMARY_GAME_MODULE というマクロが、モジュールの登録を行うマクロです。

 

UE4のC++実行ファイルは、モジュール単位で管理されます。

UE4本体も複数のモジュールから成っており、ゲームプロジェクトもその1つとして読み込まれ、実行される、という形です。(要はWindowsではdllです)

仕組み的には、ゲームモジュールはプラグインと同様のものになります。

 

FDefaultGameModuleImpl がゲームモジュールを管理するクラスなのですが、簡単のために、デフォルトでは何もしないクラスで登録されます。

これを拡張することで、モジュールがロードされた直後と、モジュールが開放される直前のタイミングを取得することが可能です。

下記のように拡張します。

IMPLEMENT_PRIMARY_GAME_MODULE(FMyCodeProjectModule, MyCodeProject, “MyCodeProject”);
これで、ゲームモジュールがロードされた直後のタイミングと、開放される直前のタイミングに処理を記述することが可能になります。

 

2.レベルに依存しない毎フレームの更新

レベルに依存せずに毎フレームの更新を行うには、FTickableGameObjectを使用します。

 

今回は、ゲームモジュールの初期化時から開放までの間、毎フレームTickが呼び出されるようにしたいと思います。

コードは下記のようになります。

class FMyCodeProjectModule : public FDefaultGameModuleImpl
{
public:
virtual void StartupModule()
{
MyTickableObject = new FMyTickableGameObject();
}
virtual void ShutdownModule()
{
delete MyTickableObject;
MyTickableObject = NULL;
}
};
IMPLEMENT_PRIMARY_GAME_MODULE(FMyCodeProjectModule, MyCodeProject, “MyCodeProject”);

これで、FMyTickableGameObject::Tick()が毎フレーム呼び出されていることが確認出来ると思います。

 

この方法での更新では、ゲームロジックに関わる処理は行わない方が良いでしょう。

アプリケーション起動中を通して必要な、OSや各種SDKとのやり取りを行う処理を、一元化して書くには便利な方法です。