【UE5】ENUMの基本【C++】

Struct(構造体)と同じ。
１．New C++ Class…を選択。

２．Noneを選択。

３．名前を決めてCreate Class。

４．エクスプローラーで、ソースファイルを削除。VisualStudio上のソースファイルもDeleteで削除。

下記のように作成するenumを、ここではstandard enumと呼ぶ。

KishiroEnums.h

#pragma once

#include "KishiroEnums.generated.h"

UENUM(BlueprintType, Category="KishiroProperty")
enum EHomeTownStd
{
	EHT_Tokyo UMETA(DisplayName = "Tokyo"),
	EHT_Kanagawa UMETA(DisplayName = "Kanagawa"),
	EHT_Chiba UMETA(DisplayName = "Chiba"),
	EHT_Saitama UMETA(DisplayName = "Saitama")
};

enumの名前は他のものと被ってはいけない。
EHT_などのPrefixをつけることで、他のenumと被る可能性がグッと減る。

//このコードはコンパイルエラーだった
//やはり同じ名前のenumはダメ
UENUM(BlueprintType, Category="KishiroProperty")
enum EHomeTownStd
{
	EHT_Tokyo UMETA(DisplayName = "Tokyo"),
	EHT_Kanagawa UMETA(DisplayName = "Kanagawa"),
	EHT_Chiba UMETA(DisplayName = "Chiba"),
	EHT_Saitama UMETA(DisplayName = "Saitama")
};

UENUM(BlueprintType, Category = "KishiroProperty")
enum EHomeTownStd2
{
	EHT_Tokyo UMETA(DisplayName = "Tokyo"),
	EHT_Kanagawa UMETA(DisplayName = "Kanagawa"),
	EHT_Chiba UMETA(DisplayName = "Chiba"),
	EHT_Saitama UMETA(DisplayName = "Saitama")
};

enumを作るだけで、それに対応したSelectノードやSwitchノードが使えるようになる。

standard enumを作成すると、UPROPERTYやUFUNCTIONで使用するときにTEnumAsByteを使う必要がある。ちょっと面倒だし分かりづらい。
MyActor.h

#include "KishiroEnums.h"

UPROPERTY(EditAnywhere, BlueprintReadWrite)
	TEnumAsByte<EHomeTownStd> HomeTownStd = EHT_Kanagawa;

下記のように作成するenumを、ここではclass enumと呼ぶ。

KishiroEnums.h

UENUM(BlueprintType, Category = "KishiroProperty")
enum class EHomeTown : uint8
{
	Gunnma UMETA(DisplayName = "Gunnma"),
	Tochigi UMETA(DisplayName = "Tochigi"),
	IBaraki UMETA(DisplayName = "IBaraki")
};

class enumなら同じ名前のenumがあっても問題ないので、prefixをつける必要がない。

//これはコンパイルエラーにならない
//クラスが分かれているから同じ名前でもOK
UENUM(BlueprintType, Category = "KishiroProperty")
enum class EHomeTown : uint8
{
	Gunnma UMETA(DisplayName = "Gunnma"),
	Tochigi UMETA(DisplayName = "Tochigi"),
	IBaraki UMETA(DisplayName = "IBaraki")
};

UENUM(BlueprintType, Category = "KishiroProperty")
enum class EHomeTown2 : uint8
{
	Gunnma UMETA(DisplayName = "Gunnma"),
	Tochigi UMETA(DisplayName = "Tochigi"),
	IBaraki UMETA(DisplayName = "IBaraki")
};

enumを作るだけで、対応したSelectノードやSwitchノードが使えるようになる。

下記のように作成するenumを、ここではbitflags enumと呼ぶ。
int型に変換することができるのが特徴。

UENUM(BlueprintType, Meta = (Bitflags))
enum class EUnitKeyword : uint8 
{
	None = 0 UMETA(Hidden),
	Activated = 1 UMETA(DisplayName = "Activated"),
	Stopped = 2 UMETA(DisplayName = "Stopped"),
	Prone = 4 UMETA(DisplayName = "Prone"),
	Running = 8 UMETA(DisplayName = "Running")
};

2進数表記

None      =00000000
Activated =00000001
Stopped   =00000010
Prone     =00000100
Running   =00001000

enumをつくるだけで、対応したSelectノードやSwitchノードが作られる。

列挙型とint型の2種類の作成方法がある。
列挙型class enumと同じ使い方
MyActor.h

UPROPERTY(EditAnywhere, BlueprintReadWrite)
	EUnitKeyword UnitKeyword = EUnitKeyword::Activated;

int型ビット演算できる。複数のenumを持てる。
MyActor.h

UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (Bitmask, BitmaskEnum = "EUnitKeyword"))
	uint8 UnitKeywords = static_cast<uint8>(EUnitKeyword::Activated);

2つ以上の状態を同時に満たすことができる。キャラクターの状態異常とかに使えるかなぁ。
例
ActiveかつRunning=00001001
StoppedかつProne=00000110

(列挙型)                ➡(uint8)
EUnitKeyword::None      ➡00000000
EUnitKeyword::Activated ➡00000001
EUnitKeyword::Stopped   ➡00000010
EUnitKeyword::Prone     ➡00000100
EUnitKeyword::Running   ➡00001000

👇Detailsパネル

注意
SelectノードやSwitchノードは列挙型では使えるが、int型では使えない。

1の補数。(0と1を入れ替える。ビット反転。)
例

static_cast<uint8>(EUnitKeyword::Activated)

上のコードが表しているのは00000001。

~static_cast<uint8>(EUnitKeyword::Activated);

~をつけると、11111110を表す。

👇補数についての解説。

補数表現とは？１の補数と２の補数の違いと計算方法まとめ - プロエンジニア

フリーランスITエンジニア専門の案件紹介・転職支援エージェント【プロエンジニア】

proengineer.internous.co.jp

ビットごとのAND代入。狙った桁のみを０にするのに使える。

左辺 &= 右辺;

左辺と右辺のAND計算の結果を左辺に代入する。
例EUnitKeyword

UnitKeywords &= ~static_cast<uint8>(EUnitKeyword::Activated);

ここで右辺は、Activated(00000001)の1の補数なので11111110を表している。

左辺のUnitKeywordsの初期値を(00000101)とすると、
左辺 00000101

右辺 11111110

AND計算は両方1なら1になり、そうでなければ0になる計算なので、
ビット(各桁)ごとの計算結果は、
結果 00000100
となる。

ここで注目すべきは、右辺のActivatedが指し示している1桁目である。
&=と~とを併用することで、他の桁の値を変えずに狙った桁のみを0(OFF)にすることができる。
青色の部分は変化せずに、赤色の部分だけ変化しているのが分かる。

関連EUnitKeyword

None      =00000000
Activated =00000001
Stopped   =00000010
Prone     =00000100
Running   =00001000

ビットごとの包括的OR代入。狙った桁のみを1にするのに使える。

左辺 |= 右辺;

左辺と右辺のOR計算の結果を左辺に代入する。
例EUnitKeyword

UnitKeywords |= ~static_cast<uint8>(EUnitKeyword::Prone);

ここで右辺はProneなので、00000100を表している。
左辺のUnitKeywordの初期値を(00001001)とすると、
左辺 00001001
右辺 00000100
OR計算は両方0なら0になり、そうでなければ1になる計算なので、
ビット(各桁)ごとの計算結果は、
結果 00001101
となる。
ここで注目すべきは、右辺のProneが指し示している3桁目である。
|=を使用することで、他の桁の値を変えずに狙った桁のみを1(ON)にすることができる。
青色の部分は変化せずに、赤色の部分だけ変化しているのが分かる。
関連EUnitKeyword

None      =00000000
Activated =00000001
Stopped   =00000010
Prone     =00000100
Running   =00001000

BPを開き、MyBlueprintパネルの歯車のマークをクリックして、Show Inherited Variablesを選択。