プロパティ

プロパティの宣言

プロパティは標準の C++ 変数記法を使って宣言され、プロパティ メタデータと変数指定子を定義する UPROPERTY マクロが先にきます。

	UPROPERTY([specifier, specifier, ...], [meta(key=value, key=value, ...)])
	Type VariableName;

Copy full snippet

UPROPERTY([specifier, specifier, ...], [meta(key=value, key=value, ...)]) Type VariableName;

主要なデータ型

整数

整数データ型の規則では、ビット サイズの前に「int」あるいは「uint」をつけます。

As Bitmasks

Integer プロパティが bitmask としてエディタに公開できるようになりました。Integer プロパティを bitmask としてマークするには、以下のようにメタ セクションに "bitmask" を追加します。

	/*~ BasicBits appears as a list of generic flags in the editor, instead of an integer field. */
	UPROPERTY(EditAnywhere, Meta = (Bitmask))
	int32 BasicBits;

Copy full snippet

/*~ BasicBits appears as a list of generic flags in the editor, instead of an integer field. */ UPROPERTY(EditAnywhere, Meta = (Bitmask)) int32 BasicBits;

このメタ タグを追加すると、個々にオンオフの切り替えが可能な一般名の付いたフラグ ("Flag 1"、"Flag 2"、"Flag 3" など) のドロップダウン リストとして integer が編集可能になります。

パラメータの UPARAM 指定子に ` Bitmask` メタタグ (値は不要) を追加することにより、Blueprint 呼び出し可能関数の整数パラメータをビットマスクとして動作させることもできます。

	/*~ You can set MyFunction using a generic list of flags instead of typing in an integer value. */
	UFUNCTION(BlueprintCallable)
	void MyFunction(UPARAM(meta=(Bitmask)) int32 BasicBitsParam)

Copy full snippet

/*~ You can set MyFunction using a generic list of flags instead of typing in an integer value. */ UFUNCTION(BlueprintCallable) void MyFunction(UPARAM(meta=(Bitmask)) int32 BasicBitsParam)

Bitflag 名をカスタマイズするには、まず "bitflags" メタ タグで UENUM を作成する必要があります。

	UENUM(Meta = (Bitflags))
	enum class EColorBits
	{
		ECB_Red,
		ECB_Green,
		ECB_Blue
	};

Copy full snippet

UENUM(Meta = (Bitflags)) enum class EColorBits { ECB_Red, ECB_Green, ECB_Blue };

ビットマスク列挙型でサポートされる値の範囲は、0〜31 です。これは、32 ビット整数変数のビット (ビット 0 から開始) に対応します。上記の例では、ビット 0 は ECB_Red、ビット 1 は ECB_Green、ビット 2 は ECB_Blueです。

別の宣言スタイルでは、ENUM_CLASS_FLAGS を使用して、列挙型を定義した後にビットマスクに変換できます。エディタ でフラグ セレクタを使用するには、メタフィールド UseEnumValuesAsMaskValuesInEditor を追加し、それを true に設定する必要があります。この方法ではビット番号ではなくマスク値を直接使用する点が主な違いです。この方法を使用して作成された同等の列挙型は、次のようになります。

	UENUM(Meta = (Bitflags, UseEnumValuesAsMaskValuesInEditor = "true"))
	enum class EColorBits
	{
		ECB_Red = 0x01,
		ECB_Green = 0x02,
		ECB_Blue = 0x04
	};

	ENUM_CLASS_FLAGS(EColorBits);

Copy full snippet

UENUM(Meta = (Bitflags, UseEnumValuesAsMaskValuesInEditor = "true")) enum class EColorBits { ECB_Red = 0x01, ECB_Green = 0x02, ECB_Blue = 0x04 }; ENUM_CLASS_FLAGS(EColorBits);

この UENUM を作成すると、次のように "BitmaskEnum" タグで参照することができるようになります。

	/*~ This property lists flags matching the names of values from EColorBits. */
	UPROPERTY(EditAnywhere, Meta = (Bitmask, BitmaskEnum = "EColorBits"))
	int32 ColorFlags;

Copy full snippet

/*~ This property lists flags matching the names of values from EColorBits. */ UPROPERTY(EditAnywhere, Meta = (Bitmask, BitmaskEnum = "EColorBits")) int32 ColorFlags;

この変更に伴い、ドロップダウン ボックスにリストされた bitflag は列挙されたクラス エントリの名前と値を受け取ります。上の例では、 この例では、ECB_Red が値 0 です。つまり、チェックされていると、bit 0 (ColorFlags に 1 を追加) がアクティベートされます。ECB_Green は bit 1 (ColorFlags に 2 を追加) に相当し、 ECB_Blue は bit 2 (ColorFlags に 4 を追加) に相当します。

同様に BitmaskEnum と適切な列挙型名を UPARAM タグのメタ セクションに追加してカスタマイズすることができます。

	/*~ MyOtherFunction shows flags named after the values from EColorBits. */
	UFUNCTION(BlueprintCallable)
	void MyOtherFunction(UPARAM(meta=(Bitmask, BitmaskEnum = "EColorBits")) int32 ColorFlagsParam)

Copy full snippet

/*~ MyOtherFunction shows flags named after the values from EColorBits. */ UFUNCTION(BlueprintCallable) void MyOtherFunction(UPARAM(meta=(Bitmask, BitmaskEnum = "EColorBits")) int32 ColorFlagsParam)

列挙型には 32 を超えるエントリを含むことができますが、最初の 32 値のみがプロパティ エディタ UI の bitmask association で 表示されます。同様に、明示的な値エントリが受け取られたら、0 から 31 の明示的な値をもつエントリはドロップダウンには含まれません。

浮動小数点型

アンリアルでは、標準の C++ 浮動小数点型である float 型と double 型が使用されています。

Boolean 型

Boolean 型は、 C++ bool キーワードで、あるいはビットフィールドとして表現されます。

	uint32 bIsHungry :1;
	bool bIsThirsty;

Copy full snippet

uint32 bIsHungry :1; bool bIsThirsty;

文字列

Unreal Engine 4 は、主要な 3 種類の文字列をサポートしています。

• FString は「動的文字型配列」の文字列型の典型といえます。
• FName は、グローバル文字列表の変更不可能な大文字・小文字を区別しない文字列への参照です。FString より小さく、より効率よく受け渡しができますが、操作は難しくなります。
• FText は、ローカリゼーションに対処するために作成された更に堅牢な文字列表現です。

使用する場合はたいてい、アンリアルは文字で TCHAR 型に依存します。TEXT() マクロは TCHAR リテラルを表すために利用できます。

	MyDogPtr->DogName = FName(TEXT("Samson Aloysius"));

Copy full snippet

MyDogPtr->DogName = FName(TEXT("Samson Aloysius"));

いつ使用するのか、どのように機能するのかなど、3 つの文字列型の詳細は「文字列の取り扱いのドキュメント」を参照してください。

プロパティ指定子