1. Epic GamesDeveloper
  3. UEnum

UEnum

Reflection data for an enumeration.

API > API/Runtime > API/Runtime/CoreUObject > API/Runtime/CoreUObject/UObject

Inheritance Hierarchy

References

   
Module CoreUObject
Header /Engine/Source/Runtime/CoreUObject/Public/UObject/Class.h
Include #include "UObject/Class.h"

Syntax

class UEnum : public UField

Remarks

Reflection data for an enumeration.

Variables

  Type Name Description
Protected variable ECppForm CppForm How the enum was originally defined.
Public variable FString CppType This will be the true type of the enum as a string, e.g. "ENamespacedEnum::InnerType" or "ERegularEnum" or "EEnumClass"
Protected variable FEnumDisplayNameFn EnumDisplayNameFn Pointer to function used to look up the enum's display name.
Protected variable EEnumFlags EnumFlags Enum flags.
Protected variable FName EnumPackage Package name this enum was in when its names were being added to the primary list
Protected variable TArray< TPair< FName, int64 > > Names List of pairs of all enum names and values.

Constructors

  Type Name Description
Public function COREUOBJECT_API

UEnum ( FVTableHelper& Helper
)

 DO NOT USE. This constructor is for internal usage only for hot-reload purposes.
Public function  

UEnum ( const FObjectInitializer& ObjectInitialzer
)

  

Functions

  Type Name Description
Public function Static void  
Public function Static UObject *  
Protected function void Adds the Names in this enum to the primary AllEnumNames list
Public function Const bool Tests if the enum contains a MAX value
Public function Const bool

FindAuthoredNameStringByValue ( FString& Out,
int64 InValue
)

 Looks for a display name with a given value and returns true and writes the unlocalized logical name to Out if one was found
Public function Const bool

FindDisplayNameTextByValue ( FText& Out,
int64 InValue
)

 Looks for a display name with a given value and returns true and writes the name to Out if one was found
Public function Const bool

FindNameStringByValue ( FString& Out,
int64 InValue
)

 Looks for a name with a given value and returns true and writes the name to Out if one was found
Public function Const FString Find the longest common prefix of all items in the enumeration.
Public function Virtual Const FString

GenerateFullEnumName ( const TCHAR* InEnumName
)

 Generates full name including EnumName:: given enum name.
Public function Virtual Const FString

GetAuthoredNameStringByIndex ( int32 InIndex
)

 Returns the unlocalized logical name originally assigned to the enum at creation.
Public function Const FString

GetAuthoredNameStringByValue ( int64 InValue
)

 Version of GetAuthoredNameByIndex that takes a value instead
Public function Const ECppForm Returns the type of enum: whether it's a regular enum, namespaced enum or C++11 enum class.
Public function Virtual Const FText

GetDisplayNameTextByIndex ( int32 InIndex
)

 Finds the localized display name or native display name as a fallback.
Public function Const FText

GetDisplayNameTextByValue ( int64 InValue
)

 Version of GetDisplayNameTextByIndex that takes a value instead
Public function Static FText

GetDisplayValueAsText ( const EnumType EnumeratorValue
)

  
Public function Static FText

GetDisplayValueAsText ( const TEnumAsByte< EnumType > EnumeratorValue
)

  
Public function Static FText

GetDisplayValueAsText ( const TCHAR* EnumPath,
const T EnumeratorValue
)

  
Public function Static FText

GetDisplayValueAsText ( const TCHAR* EnumPath,
const TEnumAsByte< T > EnumeratorValue
)

  
Public function Static void

GetDisplayValueAsText ( const EnumType EnumeratorValue,
FText& out_TextValue
)

  
Public function Static void

GetDisplayValueAsText ( const TCHAR* EnumPath,
const T EnumeratorValue,
FText& out_TextValue
)

  
Public function Const int32

GetIndexByName ( FName InName,
EGetByNameFlags Flags
)

 Gets index of name in enum, returns INDEX_NONE and optionally errors when name is not found.
Public function Const int32

GetIndexByNameString ( const FString& SearchString,
EGetByNameFlags Flags
)

 Gets index of name in enum, returns INDEX_NONE and optionally errors when name is not found.
Public function Const int32

GetIndexByValue ( int64 InValue
)

 Index is the internal index into the Enum array, and is not useful outside of the Enum system Value is the value set in the Enum Class in C++ or Blueprint Enums can be sparse, which means that not every valid Index is a proper Value, and they are not necessarily equal It is not safe to cast an Index to a Enum Class, always do that with a Value instead Gets the internal index for an enum value.
Public function Const int64 Gets max value of Enum. Defaults to zero if there are no entries.
Public function Const FString

GetMetaData ( const TCHAR* Key,
int32 NameIndex,
bool bAllowRemap
)

 Return the metadata value associated with the specified key.
Public function Const FName

GetNameByIndex ( int32 Index
)

 Gets enum name by index in Names array.
Public function Const FName

GetNameByValue ( int64 InValue
)

 Gets enum name by value. Returns NAME_None if value is not found.
Public function Const FString

GetNameStringByIndex ( int32 InIndex
)

 Returns the short name at the enum index, returns empty string if invalid
Public function Const FString

GetNameStringByValue ( int64 InValue
)

 Returns the short name matching the enum Value, returns empty string if invalid
Public function Const FText

GetToolTipTextByIndex ( int32 NameIndex
)

 Finds the localized tooltip or native tooltip as a fallback.
Public function Static void

GetValueAsName ( const EnumType EnumeratorValue,
FName& out_NameValue
)

  
Public function Static FName

GetValueAsName ( const TEnumAsByte< EnumType > EnumeratorValue
)

  
Public function Static FName

GetValueAsName ( const EnumType EnumeratorValue
)

  
Public function Static void

GetValueAsString ( const TCHAR* EnumPath,
const T EnumeratorValue,
FString& out_StringValue
)

  
Public function Static void

GetValueAsString ( const EnumType EnumeratorValue,
FString& out_StringValue
)

  
Public function Static FString

GetValueAsString ( const TCHAR* EnumPath,
const TEnumAsByte< T > EnumeratorValue
)

  
Public function Static FString

GetValueAsString ( const TCHAR* EnumPath,
const T EnumeratorValue
)

  
Public function Static FString

GetValueAsString ( const TEnumAsByte< EnumType > EnumeratorValue
)

  
Public function Static FString

GetValueAsString ( const EnumType EnumeratorValue
)

  
Public function Const int64

GetValueByIndex ( int32 Index
)

 Gets enum value by index in Names array. Asserts on invalid index
Public function Const int64

GetValueByName ( FName InName,
EGetByNameFlags Flags
)

 Gets enum value by name, returns INDEX_NONE and optionally errors when name is not found.
Public function Const int64

GetValueByNameString ( const FString& SearchString,
EGetByNameFlags Flags
)

 Gets enum value by name, returns INDEX_NONE and optionally errors when name is not found.
Public function Static FString

GetValueOrBitfieldAsString ( const TEnumAsByte< EnumType > EnumeratorValue
)

 TEnumAsByte produces a warning if you use it with EnumClass, so this UE_REQUIRES keeps this overload from being matched in that case
Public function Static FString

GetValueOrBitfieldAsString ( const EnumType EnumeratorValue
)

  
Public function Static FString

GetValueOrBitfieldAsString ( const IntegralType EnumeratorValue
)

  
Public function Static FString

GetValueOrBitfieldAsString ( const TCHAR* EnumPath,
const TEnumAsByte< T > EnumeratorValue
)

  
Public function Static FString

GetValueOrBitfieldAsString ( const TCHAR* EnumPath,
const T EnumeratorValue
)

  
Public function Static void

GetValueOrBitfieldAsString ( const IntegralType EnumeratorValue,
FString& out_StringValue
)

  
Public function Static void

GetValueOrBitfieldAsString ( const TCHAR* EnumPath,
const T EnumeratorValue,
FString& out_StringValue
)

  
Public function Static void

GetValueOrBitfieldAsString ( const EnumType EnumeratorValue,
FString& out_StringValue
)

  
Public function Const FString

GetValueOrBitfieldAsString ( int64 InValue
)

 If the enumeration is declared as UENUM(Flags), returns a string of the form A | B | C representing set bits A, B, and C.
Public function Const bool

HasAnyEnumFlags ( EEnumFlags InFlags
)

  
Public function Const bool

HasMetaData ( const TCHAR* Key,
int32 NameIndex
)

 Wrapper method for easily determining whether this enum has metadata associated with it.
Public function Static bool

IsFullEnumName ( const TCHAR* InEnumName
)

 Checks if a enum name is fully qualified name.
Public function Const bool

IsValidEnumName ( FName InName
)

 Checks if enum has entry with given name. Includes autogenerated _MAX entry.
Public function Const bool

IsValidEnumValue ( int64 InValue
)

 Checks if enum has entry with given value. Includes autogenerated _MAX entry.
Public function Static int64

LookupEnumName ( FName PackageName,
FName TestName,
EFindFirstObjectOptions Options,
UEnum** OutFoundEnum
)

 Searches the list of all enum value names for the specified name
Public function Static int64

LookupEnumNameSlow ( FName PackageName,
const TCHAR* InTestShortName,
EFindFirstObjectOptions Options,
UEnum** OutFoundEnum
)

 Searches the list of all enum value names for the specified name
Public function Const int32  
Public function Static int64

ParseEnum ( const TCHAR*& Str
)

 Parses the passed in string for a name, then searches for that name in any Enum (in any package)
Public function Const void

RemoveMetaData ( const TCHAR* Key,
int32 NameIndex
)

 Remove given key meta data
Public function void Removes the Names in this enum from the primary AllEnumNames list
Public function Virtual Const int64

ResolveEnumerator ( FArchive& Ar,
int64 EnumeratorIndex
)

 Try to update an out-of-date enum index after an enum changes at runtime
Public function void

SetEnumDisplayNameFn ( FEnumDisplayNameFn InEnumDisplayNameFn
)

 Associate a function for looking up Enum display names by index, only intended for use by generated code
Public function void

SetEnumFlags ( EEnumFlags FlagsToSet
)

  
Public function Virtual bool

SetEnums ( TArray< TPair< FName, int64 >>& InNames,
ECppForm InCppForm,
EEnumFlags InFlags,
bool bAddMaxKeyIfMissing
)

 Sets the array of enums.
Public function Const void

SetMetaData ( const TCHAR* Key,
const TCHAR* InValue,
int32 NameIndex
)

 Set the metadata value associated with the specified key.
Public function Static UClass * Returns a UClass object representing this class at runtime
Public function Static EClassCastFlags Returns the static cast flags for this class
Public function Static const TCHAR * Returns the package this class belongs in
Public function Static void  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Operators

  Type Name Description
Public function void

operator delete ( void* InMem
)

 Eliminate V1062 warning from PVS-Studio while keeping MSVC and Clang happy.
Public function void *

operator new ( const size_t InSize,
EInternal InInternalOnly,
UObject* InOuter,
FName InName,
EObjectFlags InSetFlags
)

 For internal use only; use StaticConstructObject() to create new objects.
Public function void *

operator new ( const size_t InSize,
EInternal* InMem
)

 For internal use only; use StaticConstructObject() to create new objects.

Enums

  Type Name Description
Public enum ECppForm How this enum is declared in C++, affects the internal naming of enum values  

Typedefs

Name Description
Super Typedef for the base class (UField)
ThisClass Typedef for UEnum.

Constants

Name Description
AllEnumNames Global list of all value names used by all enums in memory, used for property text import
AllEnumNamesLock Lock to be taken when accessing AllEnumNames
StaticClassFlags Bitwise union of EClassFlags pertaining to this class.

Deprecated Functions

  Type Name Description
Protected function void AddNamesToMasterList is deprecated, please use AddNamesToPrimaryList instead.
Public function Static int64

LookupEnumName ( FName TestName,
UEnum** FoundEnum
)

 LookupEnumName that takes only enum name is deprecated. Please use the version of this function that also takes enum package name.
Public function Static int64

LookupEnumNameSlow ( const TCHAR* InTestShortName,
UEnum** FoundEnum
)

 LookupEnumNameSlow that takes only enum name is deprecated. Please use the version of this function that also takes enum package name.
Public function void RemoveNamesFromMasterList is deprecated, please use RemoveNamesFromPrimaryList instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page