Unreal Engine 5 ドキュメントは Epic Developer Community に移動しました

Unreal Engine にはゲーム オブジェクトを処理する堅牢なシステムがあります。Unreal のオブジェクトの基本クラスは、 UObject です。UObject の処理システムで認識できるように、UCLASS マクロを使用して UObject から派生したクラスに タグ付けすることができます。

UCLASS マクロ

UClass マクロは、UObject に、Unreal ベースの型を記述する UClass への参照を与えます。各 UClass は、'Class Default Object' (短縮すると CDO) と呼ばれるひとつのオブジェクトを維持しています。この CDO は、 基本的にデフォルトの 'template' オブジェクトで、クラス コンストラクタによって生成され、その後は修正されません。UCLASS と CDO は通常は読み取り専用と見なされますが、 任意のオブジェクトのインスタンスに対して読み出すことができます。オブジェクト インスタンスの UCLASS は、GetClass() 関数を使用していつでもアクセスできます。

UCLASS には、クラスを定義するプロパティと関数のセットがあります。これらは、ネイティブ コードで使用可能な通常の C++ 関数および変数ですが、このオブジェクト システム内でどのように振る舞うかを制御する アンリアル固有のメタデータでタグ付けされています。タグ付けのシンタックスの詳細は プログラミングのリファレンス を参照してください。

UObject クラスには、対応する UCLASS 内には存在しないネイティブのみのプロパティも含まれることに注意してください。

プロパティと関数の型

UObjects にはメンバー変数 (プロパティ) または任意の型の関数があります。ただし、Unreal Engine がこうした変数や関数を認識し、操作するためには、特殊なマクロでマーク付けされて、一定の標準に従わなければなりません。こうした標準の詳細については、 プロパティ と UFunction のリファレンス ページをご覧ください。

オブジェクト作成

新規 UObject インスタンスおよび標準の new 演算子を作成するために使用可能な関数はいくつかあり、それぞれ独自の用途があります。

UObjects の機能

このシステムをすべてのケースで使用することは必須でもないし、必ずしも適切でもありませんが、使用すると多くのメリットがあります。例えば、以下がその例です。

• ガーベジ コレクション

• 参照の更新

• リフレクション

• シリアライズ

• デフォルトのプロパティ変更の自動更新

• プロパティの自動初期化

• エディタの自動統合

• ランタイムに利用可能な型情報

• ネットワーク レプリケーション

こうした各システムの詳しい情報については、 アンリアルでのオブジェクト処理 のドキュメントをご覧ください。

Unreal Header Tool

UObject 派生型が提供する機能を利用するには、必要な情報を照合するためにヘッダー ファイルでこうした型に対してプリプロセシング ステップを実行する必要があります。このプリプロセシング ステップは UnrealHeaderTool (UHT) によって行われます。

UObject 派生型には、守るべき特定の構造があります。これについて以下で説明します。

ヘッダー ファイル形式

ソース (.cpp) ファイルでの UObject の実装は他の C++ クラスと同様ですが、Unreal Engine 4 で適切に機能するためにヘッダー (.h) ファイルでの定義は特定の基本構造に従わなければなりません。エディタの "New C++ Class" コマンドを使用すると、適切にフォーマットされたヘッダー ファイルを非常に簡単にセットアップすることができます。UObject 派生クラスの基本的なヘッダー ファイルは以下のようになります。この UObject の派生が UMyObject であり、それが作成されたプロジェクトが MyProject であることを前提にしています。

#pragma once

#include 'Object.h'
#include 'MyObject.generated.h'

/**
 * 
 */
UCLASS()
class MYPROJECT_API UMyObject : public UObject
{
    GENERATED_BODY()

};

この中で Unreal 特有の部分は、以下の通りです。

#include "MyObject.generated.h"

この行は、ファイルの最後の #include ディレクティブになります。このヘッダー ファイルが他のクラスについて認識する必要があれば、ファイル内の任意の場所で前方宣言するか、または MyObject.generated.h の上にインクルードします。

UCLASS()

UCLASS マクロは UMyObject を Unreal Engine に認識させます。このマクロは、クラスに対してどの機能をオンにするか、オフにするかを決める様々な クラス指定子 をサポートします。

class MYPROJECT_API UMyObject : public UObject

MyProject が UMyObject クラスを他のモジュールにエクスポーズしたい場合は MYPROJECT_API の指定は必須です。これはゲーム プロジェクトが含むモジュールやプラグインで非常に役立ちます。また、これは移植性があり、独立した機能を複数のプロジェクト間に提供するためにクラスを意図的にエクスポーズします。

GENERATED_BODY()

GENERATED_BODY() マクロは引数を取りませんが、エンジンが必要とする基礎構造をサポートするクラスをセットアップします。これはすべての UCLASS で必要です。

オブジェクトの更新

ティックは、Unreal Engine でオブジェクトがどのようにアップデートされたかを表します。すべてのオブジェクトには、各フレームでティックする機能があり、必要な更新の計算やアクションを行うことができます。

オブジェクトには、ビルトインの更新機能はありません。しかし、必要があれば、 inherits クラス指定子を使用して FTickableGameObject クラスから継承してこの機能を追加することができます。 これで、 Tick() 関数を実装できるようになります。この関数は、エンジンによって各フレームで呼び出されます。ほとんどのインゲームのオブジェクトは、 アクタ であり、フレーム毎に 1 回ではなくユーザー設定の最小限の間隔でティックすることができます。

オブジェクトのデストラクション

オブジェクトが参照されなくなると、オブジェクトの破棄は、ガーベジ コレクション システムによって自動的に処理されます。これは、 UPROPERTY ポインタ、またはエンジン コンテナや スマート ポインタ のクラス インスタンスは、強い参照を持たないことを意味します。ガーベジ コレクタが実行し、参照されていないオブジェクトが見つかると削除されます。さらに、オブジェクト上で関数 MarkPendingKill() を直接呼出しできるようになります。この関数はこのオブジェクトへのすべてのポインタを NULL に設定し、グローバル検索からこのオブジェクトを取り除きます。繰り返しになりますが、このオブジェクトは次のガーベジ コレクション パスでは完全に削除されます。