Choose your operating system:
Windows
macOS
Linux
クラス、インターフェイス、構造体、列挙型変数、列挙型変数の値、関数、プロパティを宣言するときに、 メタデータ指定子 を宣言に追加して、エンジンやエディタの様々な側面でどのようにインタラクタするかを制御することができます。データ構造またはメンバのそれぞれの型には、固有のメタデータ指定子のリストがあります。
メタデータはエディタのみに存在しています。メタデータにアクセスするゲーム ロジックを書かないでください。
メタデータ指定子を追加するには、指定子の後に
meta
という言葉を使用し、該当する場合はそれらの値を UCLASS
、
UENUM
、
UINTERFACE
、
USTRUCT
、
UFUNCTION
、
UPROPERTY` マクロで以下のように使用します。
{UCLASS/UENUM/UINTERFACE/USTRUCT/UFUNCTION/UPROPERTY}(SpecifierX, meta=(MetaTag1="Value1", MetaTag2, ..), SpecifierY)
列挙型の特定の値にメタデータ指定子を追加するには、
UMETA
タグを値に追加します (カンマがある場合はカンマの前に)。以下のようになります。
UENUM()
enum class EMyEnum : uint8
{
// DefaultValue Tooltip
DefaultValue = 0 UMETA(MetaTag1="Value1", MetaTag2, ..),
// ValueWithoutMetaSpecifiers Tooltip
ValueWithoutMetaSpecifiers,
// ValueWithMetaSpecifiers Tooltip
ValueWithMetaSpecifiers UMETA((MetaTag1="Value1", MetaTag2, ..),
// FinalValue Tooltip
FinalValue (MetaTag1="Value1", MetaTag2, ..)
};
クラス メタデータ指定子
クラスは以下のメタタグ指定子を使用することができます。
クラス メタ タグ |
効果 |
---|---|
|
このコンポーネント クラスが存在する場合、ブループリントでスポーン可能です。 |
|
ブループリント関数ライブラリでのみ有効です。この指定子は Animation ブループリントのノンゲーム スレッドでこのクラスの関数を呼び出し可能とマーク付けします。 |
|
Actor クラスと Component クラスで使用されます。ネイティブ クラスがティックできない場合、このアクタまたはコンポーネントを元にしてブループリントが生成したクラスは、
|
|
Actor クラスと Component クラスで使用されます。ネイティブ クラスがティックできない場合、
|
|
ビヘイビア ツリー ノードで、クラスが非推奨であることを示し、コンパイル時に警告が表示されます。 |
|
このメタデータを含む非推奨のクラスには、コンパイル中にブループリント スクリプトが生成する標準の非推奨の警告とともにこのテキストが含まれます。 |
|
ブループリント スクリプト内のこのノード名は、コードが生成する名前の代わりにここで指定する値で置き換えられます。 |
|
ブループリントで Generic Create Object ノードを使用するクラスのオブジェクトをスポーンしないでください。この指定子は、アクタでもアクタ コンポーネントでもないブループリント タイプのクラスにのみ適用されます。 |
|
Async Task ノードでこのクラスのプロキシ オブジェクトを公開します。 |
|
クラスの最初のサブクラスが継承されるすべての
|
|
このクラスがブループリントを作成するために使用可能 (または使用不可) の基本クラスであることを示します。
|
|
オーバーライドできないブループリントのイベント リストです。 |
|
クラスと互換性がないインターフェースのリストです。 |
|
Blueprint Function Library クラスが使用し、リストに名前があるクラスに使用を制限します。 |
|
親クラスのピッカー ダイアログなどフル ツールチップでは長すぎる場合に短いツールチップを使います。 |
|
このクラスが所有するグラフに配置されたブループリント ノードが、ワールド コンテキストのピンを通常は非表示であっても表示しなければならないことを示します。このクラスのオブジェクトはワールド コンテキストとして使うことはできないからです。 |
|
クラスが階層データを使うことを示します。[Details (詳細)] パネルで階層編集機能をインスタンス化するために使用されます。 |
|
コード コメントから自動的に生成されたツールチップをオーバーライドします。 |
列挙型変数のメタデータ指定子
列挙型は以下のメタデータ指定子を使用することができます。
列挙型メタタグ |
効果 |
---|---|
|
|
|
型を実験的でサポート対象外としてラベルします。 |
|
引用符で囲んだ文字列は、Unreal Header Tool が生成したデフォルト名ではなく、列挙型変数名としてエディタ内で使用されます。 |
|
コード コメントから自動的に生成されたツールチップをオーバーライドします。 |
列挙型変数内の個々の値には独自のメタデータ指定子があります。他のメタデータ指定子と少し違う点は、これらは上位レベルのキーワード
UMETA
を使用し、それらが修正する前ではなく後ろで指定される点です。
列挙型変数値 UMeta タグ |
効果 |
---|---|
|
この値の名前は、コードが生成した名前ではなくて、ここで指定されたテキストです。 |
|
この値はエディタには表示されません。 |
|
コード コメントから自動的に生成されたツールチップをオーバーライドします。 |
インターフェース メタデータ指定子
インターフェースは以下のメタタグ指定子を使用することができます。
ブループリント イベントは実行可能なインターフェースのみで許可されるようにします。内部専用機能が許可されています。 このインターフェイスに、ブループリントが定義されていないブループリント呼び出し可能関数が含まれている場合は、ネイティブに実装する必要があることを確認してください。
インターフェース メタ タグ |
効果 |
---|---|
|
このインターフェースは内部専用インターフェース以外の
|
構造体メタデータ指定子
構造体は以下のメタタグ指定子を使用することができます。
構造体メタ タグ |
効果 |
---|---|
|
この構造体はカスタムのBreak Struct ノードを持つことを示します。モジュール、クラス、および関数の名前を指定しなければなりません。 |
|
この構造体はカスタムの Make Struct ノードを持つことを示します。モジュール、クラス、および関数の名前を指定しなければなりません。 |
|
Make Struct ノードと Break Struct ノードのピンはデフォルトで非表示になっています。 |
|
親クラスのピッカー ダイアログなどフル ツールチップでは長すぎる場合に短いツールチップを使います。 |
|
コード コメントから自動的に生成されたツールチップをオーバーライドします。 |
関数メタデータ指定子
関数メタ タグ |
効果 |
---|---|
|
コンマで区切られたパラメータのリストが詳細ピンとして表示されます (UI の展開が必要)。 |
|
|
|
|
|
|
|
リストされているパラメータは参照によって渡されますが、ピンが接続されていなければ自動作成されるデフォルトを持ちます。これは配列ピンで使用されるブループリントの便利な機能です。 |
|
ブループリント関数ライブラリから静的な
|
|
この関数は内部実装の詳細です。他の関数やノードを実装するために使われます。グラフ内で直接公開されることはありません。 |
|
この関数は、ブループリントで所有しているオブジェクトでのみ呼び出し可能です。他のインスタンス上での呼び出しはできません。 |
|
|
|
|
|
|
|
リストされているパラメータはすべてワイルドカードとして扱われます。この指定子は
カスタム
|
|
|
|
ブループリントでこの関数を参照すると、関数が非推奨であることを示すコンパイルに関する警告が出ます。
|
|
関数が非推奨であると、それを使用するブループリントをコンパイルしようとすると、このメッセージが標準の非推奨の警告に追加されます。 |
|
関数の戻り値の型は、指定されたパラメーター ピンに接続されている入力に一致するように動的に変更されます。パラメータは
|
|
|
|
ブループリント内のこのノード名は、コードが生成する名前の代わりにここで指定する値で置き換えられます。 |
|
|
|
|
|
"self" ピンを隠します。"self" ピンは関数が呼び出されているオブジェクトを示すために使われます。"self" ピンは
|
|
|
|
ブループリント グラフで関数を呼び出すノードを配置する場合など、この関数を検索するときに使用可能なキーワード一式を指定します。 |
|
潜在的 (latent) アクションを示します。潜在的アクショには、
|
|
Latent
|
|
|
|
|
|
ブループリント関数ライブラリでのみ有効です。この関数は、所有しているクラスの一般的な
|
|
親クラスのピッカー ダイアログなどフル ツールチップでは長すぎる場合に短いツールチップを使います。 |
|
コード コメントから自動的に生成されたツールチップをオーバーライドします。 |
|
この関数はアクタの構築中には安全に呼び出すことはできません。 |
|
|
プロパティ メタデータ指定子
プロパティ メタ タグ |
効果 |
---|---|
|
|
|
|
|
|
|
integer のプロパティに使用されます。UI に入力する有効な値を 0 と配列のプロパティの名前の長さにクランプします。 |
|
|
|
|
|
ブループリントのコンパイラによってプロパティのデフォルトが生成されて、コンパイル後に
|
|
float と integer のプロパティに使用されます。プロパティに入力可能な最小値、
|
|
float と integer のプロパティに使用されます。プロパティに入力可能な最大値、
|
|
このプロパティは、 config (
|
|
|
|
このプロパティは、ブループリント エディタでの中で、プロパティが両方とも同じカテゴリにある限り、ソースコードの順番に関係なく
|
|
コードが生成する名前の代わりになるプロパティの表示名です。 |
|
2 つのプロパティの
|
|
プロパティがアセット タイプであることを示し、選択したアセットのサムネイルを表示します。 |
|
このプロパティの編集を無効にするかどうかを示すために使うブール プロパティに名前を付けます。プロパティ名の前に "!" を付けるとテストが反転します。 EditCondition メタ タグは単一の boolean プロパティに限定されなくなりました。本格的な表現式パーサーを使って評価されるため、C++ 表現式を完全にインクルードできるようになりました。 |
|
ドラッグすることで配列の要素の順番が変わるのを防ぎます。 |
|
|
|
ブループリント エディタで関数リストを構築するときに関数を公開するカテゴリのリストを指定します。 |
|
このクラスのタイプで Spawn Actor ノードでこのプロパティを公開するかを指定します。 |
|
|
|
このプロパティに対する "Get" Blueprint ノードに、その値のコピーではなく const 参照をプロパティに返させます。Sparse Class Data を使ってのみ、
|
|
|
|
|
|
他のプロパティで切り替わり、単独では表示されない編集条件として、ブール プロパティはインラインでのみ表示されることを表します。 |
|
|
|
Transform プロパティ、Rotator プロパティ、または Transforms、Rotators の配列で使用されます。移動可能なウィジェットとしてプロパティがビューポートに公開されることを示します。 |
|
ブループリント生成がこのプロパティに対して "get" ノードを生成しないようにします。Sparse Class Data でのみ使用可能です。 |