プロパティ指定子

エンジンおよびエディタの各部でのプロパティの動作を指定する UProperties の宣言時に使用するキーワード

Choose your operating system:

Windows

macOS

Linux

コンテンツ

メタデータ指定子

プロパティを宣言する時、 Property Specifiers を宣言に追加して、Unreal Engine および Unreal Editor の各部で、プロパティがどのように動作するのかを制御することができます。


プロパティタグ	効果
`AdvancedDisplay`	このプロパティは任意のパネルの [Advanced (ドロップダウン)] セクションに表示されます。
`AssetRegistrySearchable`	この指定子は、これをメンバー変数として格納するアセットクラスインスタンスに対して、このプロパティとその値が自動的にアセットレジストリへ追加されることを示します。構造体プロパティもしくはパラメータへの使用は不正です。
`BlueprintAssignable`	マルチキャストデリゲートとのみ使用できます。ブループリントで割り当てるためにプロパティを公開します。
`BlueprintAuthorityOnly`	このプロパティはマルチキャストデリゲートでなければなりません。ブループリントでは `BlueprintAuthorityOnly` というタグがついたイベントのみ受け入れます。
`BlueprintCallable`	マルチキャストデリゲートのみです。ブループリントのコードで呼び出すためにプロパティは公開されなければいけません。
`BlueprintGetter=GetterFunctionName`	このプロパティはカスタムアクセサ関数を指定します。このプロパティに `BlueprintSetter` または `BlueprintReadWrite` のタグがなければ、暗黙的に `BlueprintReadOnly` です。
`BlueprintReadOnly`	このプロパティはブループリントで読み取り可能ですが、修正はできません。この指定子は `BlueprintReadWrite` 指定子とは互換性がありません。
`BlueprintReadWrite`	このプロパティはブループリントでの読み取りと書き込みが可能です。この指定子は `BlueprintReadOnly` 指定子とは互換性がありません。
`BlueprintSetter=SetterFunctionName`	このプロパティは、カスタムミューテータ関数を持ち、暗黙的に `BlueprintReadWrite` にタグ付けされています。ミューテータ関数は、同じクラスで名前付けしてその一部でなければなりません。
`Category="TopCategory\|SubCategory\|..."`	ブループリントの編集ツールで表示される場合に、プロパティのカテゴリを指定します。\| 演算子を使ってネスティングするカテゴリを定義します。
`Config`	このプロパティは設定可能になります。現在の値をクラスに関連する `.ini` ファイルに保存することができ、作成時にロードされます。デフォルトのプロパティでは、値を設定できません。 `BlueprintReadOnly` を意味します。
`DuplicateTransient`	複製のタイプ (コピー/貼り付け、バイナリの複製など)を問わず複製中は、プロパティの値は常にデフォルト値にリセットされることを示します。
`EditAnywhere`	このプロパティはエディタのプロパティウィンドウでアーキタイプ上とインスタンス上での編集が可能なことを示します。この指定子は "Visible" 指定子とは互換性がありません。
`EditDefaultsOnly`	このプロパティはプロパティウィンドウで編集が可能なことを示しますが、アーキタイプ上のみの編集が可能です。この指定子は "Visible" 指定子とは互換性がありません。
`EditFixedSize`	動的配列に対してのみ有効です。ユーザーが、アンリアルエディタプロパティウィンドウで配列の長さを変更してしまうことを防ぎます。
`EditInline`	ユーザーはこのプロパティに参照されたオブジェクトのプロパティを、アンリアルエディタのプロパティインスペクタ内で編集できます (オブジェクト参照の配列を含むオブジェクト参照でのみ有用です)。
`EditInstanceOnly`	このプロパティはプロパティウィンドウで編集が可能なことを示しますが、インスタンス上のみでアーキタイプ上ではありません。この指定子は "Visible" 指定子とは互換性がありません。
`Export`	オブジェクトプロパティ (またはオブジェクトの配列) にのみ有用です。このプロパティに割り当てられたオブジェクトは、コピー (コピー / ペースト操作など) される時、オブジェクト参照そのものを単に出力するのではなく、サブオブジェクトブロックとしてそのまま全体がエクスポートされることを表します。
`GlobalConfig`	サブクラスではオーバーライドできない以外は、 `Config` と機能は同じです。デフォルトのプロパティでは、値を設定できません。 `BlueprintReadOnly` を意味します。
`Instanced`	オブジェクトの ( `UCLASS` ) プロパティのみです。このクラスのインスタンスが作成される場合、デフォルトでこのプロパティに割り当てられたオブジェクトのユニークなコピーが作成されます。クラスのデフォルトプロパティで定義されたサブオブジェクトのインスタンス化に使用されます。 `EditInline` と `Export` を意味します。
`Interp`	シーケンサーのトラックによって、経時的に値を操作できることを表します。
`Localized`	このプロパティの値は、ローカライズされた値を定義します。文字列に使用する場合が多いです。 `ReadOnly` を意味します。
`Native`	プロパティはネイティブになります。C++ コードはプロパティのシリアル化とガーベジコレクションへの公開に関与します。
`NoClear`	このオブジェクト参照がエディタから None に設定されないようにします。エディタの [Clear (および Browse)] ボタンを非表示にします。
`NoExport`	ネイティブクラスに対してのみ有用です。このプロパティは自動生成クラス宣言に含まれてはいけません。
`NonPIEDuplicateTransient`	このプロパティは、Play In Editor (PIE) セッションのために複製中の場合を除いて、複製中にデフォルト値にリセットされます。
`NonTransactional`	このプロパティ値に対する変更はエディタの元に戻す / やり直す操作の履歴に含まれないことを表します。
`NotReplicated`	複製をスキップします。サービス要求関数の構造体メンバーとパラメータにのみ適用されます。
`Replicated`	プロパティはネットワーク上でレプリケートされます。
`ReplicatedUsing=FunctionName`	`ReplicatedUsing` 指定子は、コールバック関数を指定します。これは、ネットワーク上でプロパティが更新されたときに実行されます。
`RepRetry`	構造体のプロパティでのみ有用です。完全に送信されなかった場合 (例、ネットワーク上でのシリアライズにオブジェクト参照がまだ利用できない)、このプロパティのレプリケーションを再試行します。単純な参照では、このプロパティはデフォルトですが、構造体の場合は帯域幅の負荷を考えると好ましくありません。フラグが指定されていない限りは、使用しない方がいいでしょう。
`SaveGame`	この指定子は、プロパティレベルでチェックポイント / 保存システムにフィールドを明示的にインクルードする単純な方法です。保存したゲームの一部にするつもりの全フィールドにこのフラグを設定し、プロキシアーカイバーを使って読み出し / 書き込むことができます。
`SerializeText`	ネイティブプロパティはテキストとしてシリアライズしなくてはいけません ( `ImportText` 、 `ExportText` )。
`SkipSerialization`	このプロパティはシリアライズされませんが、テキスト形式でエクスポート可能です (例、コピー / 貼付け操作など)。
`SimpleDisplay`	[Details] パネルに表示され、編集可能なプロパティが表示されます。[Advanced] セクションを開かなくても表示されます。
`TextExportTransient`	このプロパティはテキスト形式ではエクスポートされません (そのため例えばコピー / 貼付け操作では使用できません)。
`Transient`	プロパティは一時的なものです。つまり、保存やロードはされません。このようにタグ付けされたプロパティは、ロード時にゼロで埋められます。
`VisibleAnywhere`	このプロパティはすべてのプロパティウィンドウで可視化できることを示しますが、編集は一切できません。この指定子は "Edit" 指定子とは互換性がありません。
`VisibleDefaultsOnly`	このプロパティはアーキタイプからプロパティウィンドウのみで可視化できることを示しますが、編集は一切できません。この指定子は "Edit" 指定子とは互換性がありません。
`VisibleInstanceOnly`	このプロパティはアーキタイプからではなく、インスタンスからプロパティウィンドウのみで可視化できることを示しますが、編集は一切できません。この指定子は "Edit" 指定子とは互換性がありません。

メタデータ指定子

クラス、インターフェイス、構造体、列挙型変数、列挙型変数の値、関数、プロパティを宣言するときに、 メタデータ指定子 を宣言に追加して、エンジンやエディタの様々な側面でどのようにインタラクタするかを制御することができます。データ構造またはメンバのそれぞれの型には、固有のメタデータ指定子のリストがあります。

メタデータはエディタのみに存在しています。メタデータにアクセスするゲームロジックを書かないでください。


プロパティメタタグ	効果
`AllowAbstract="true/false"`	`Subclass` と `SoftClass` のプロパティで使用されます。クラスピッカーで抽象クラス型を表示するかを示します。
`AllowedClasses="Class1, Class2, .."`	`FSoftObjectPath` プロパティで使われます。アセットピッカーに表示されるクラスの型を示すコンマで区切られたリストです。
`AllowPreserveRatio`	`FVector` プロパティで使われます。このプロパティを [Details (詳細)] パネルに表示するときに、ratio のロックが追加されます。
`ArrayClamp="ArrayProperty"`	integer のプロパティに使用されます。UI に入力する有効な値を 0 と配列のプロパティの名前の長さにクランプします。
`AssetBundles`	`SoftObjectPtr` または `SoftObjectPath` のプロパティで使用します。Primary Data Assets 内で使用されるバンドル名のリストで、参照がどのバンドルの一部であるかを指定します。
`BlueprintBaseOnly`	`Subclass` と `SoftClass` のプロパティで使用されます。クラスピッカーで Blueprint クラスのみを表示するかを示します。
`BlueprintCompilerGeneratedDefaults`	ブループリントのコンパイラによってプロパティのデフォルトが生成されて、コンパイル後に `CopyPropertiesForUnrelatedObjects` 関数が呼び出されてもコピーされません。
`ClampMin="N"`	float と integer のプロパティに使用されます。プロパティに入力可能な最小値、 `N` を指定します。
`ClampMax="N"`	float と integer のプロパティに使用されます。プロパティに入力可能な最大値、 `N` を指定します。
`ConfigHierarchyEditable`	このプロパティは、 config ( `.ini` ) ファイルにシリアル化されて、 config 階層のどこにでも設定することができます。
`ContentDir`	`FDirectoryPath` プロパティによって使用されます。このパスは、 `Content` フォルダ内のスレートスタイルのディレクトリピッカーを使って選ぶことができます。
`DisplayAfter="PropertyName"`	このプロパティは、ブループリントエディタでの中で、プロパティが両方とも同じカテゴリにある限り、ソースコードの順番に関係なく `PropertyName` という名前のプロパティの直後に表示されます。複数のプロパティの `DisplayAfter` 値と `DisplayPriority` 値が同じ場合、ヘッダファイルで宣言された順番で、名前付きプロパティの後に表示されます。
`DisplayName="Property Name"`	コードが生成する名前の代わりになるプロパティの表示名です。
`DisplayPriority="N"`	2 つのプロパティの `DisplayAfter` 値が同じである、または同じカテゴリで `DisplayAfter` メタタグがない場合にこのプロパティがソート順を決定します。優先度が高い値は 1 です。つまり、, meaning that a property with a `DisplayPriority` 値が 1 のプロパティは `DisplayProirity` 値が 2 のプロパティに優先します。複数のプロパティの `DisplayAfter` 値が同じ場合、ヘッダファイルで宣言された順番で、名前付きプロパティの後に表示されます。
`DisplayThumbnail="true"`	プロパティがアセットタイプであることを示し、選択したアセットのサムネイルを表示します。
`EditCondition="BooleanPropertyName"`	このプロパティの編集を無効にするかどうかを示すために使うブールプロパティに名前を付けます。プロパティ名の前に "!" を付けるとテストが反転します。 EditCondition メタタグは単一の boolean プロパティに限定されなくなりました。本格的な表現式パーサーを使って評価されるため、C++ 表現式を完全にインクルードできるようになりました。
`EditFixedOrder`	ドラッグすることで配列の要素の順番が変わるのを防ぎます。
`ExactClass="true"`	`AllowedClasses` と合わせて `FSoftObjectPath` プロパティで使用されます。 `AllowedClasses` で指定されているものと同じクラスだけを使用可能か、サブクラスも有効であるかを示します。
`ExposeFunctionCategories="Category1, Category2, .."`	ブループリントエディタで関数リストを構築するときに関数を公開するカテゴリのリストを指定します。
`ExposeOnSpawn="true"`	このクラスのタイプで Spawn Actor ノードでこのプロパティを公開するかを指定します。
`FilePathFilter="FileType"`	`FFilePath` プロパティによって使用されます。ファイルピッカーで表示するパスフィルタを示します。共通の値として、"uasset" と "umap" 値を含みますが、他にも使える値があります。
`GetByRef`	このプロパティに対する "Get" Blueprint ノードに、その値のコピーではなく const 参照をプロパティに返させます。Sparse Class Data を使ってのみ、 `NoGetter` が存在しない場合のみ使用可能です。
`HideAlphaChannel`	`FColor` プロパティと `FLinearColor` プロパティで使用されます。詳細で、プロパティウィジェットを表示するときに `Alpha` プロパティが非表示になることを示します。
`HideViewOptions`	`Subclass` と `SoftClass` のプロパティで使用されます。クラスピッカーで表示オプションを変更する機能を隠します。
`InlineEditConditionToggle`	他のプロパティで切り替わり、単独では表示されない編集条件として、ブールプロパティはインラインでのみ表示されることを表します。
`LongPackageName`	`FDirectoryPath` プロパティによって使用されます。パスを長いパッケージ名に変換します。
`MakeEditWidget`	Transform プロパティ、Rotator プロパティ、または Transforms、Rotators の配列で使用されます。移動可能なウィジェットとしてプロパティがビューポートに公開されることを示します。
`NoGetter`	ブループリント生成がこのプロパティに対して "get" ノードを生成しないようにします。Sparse Class Data でのみ使用可能です。

タグ

UPROPERTY

Specifiers

Unreal Engine のドキュメントを改善するために協力をお願いします！どのような改善を望んでいるかご意見をお聞かせください。

調査に参加する

キャンセル