Choose your operating system:
Windows
macOS
Linux
Module |
|
Header |
/Engine/Source/Runtime/CoreUObject/Public/UObject/Class.h |
Include |
#include "UObject/Class.h" |
class UEnum : public UField
Reflection data for an enumeration.
Name | Description | ||
---|---|---|---|
|
CppForm |
How the enum was originally defined. |
|
|
CppType |
This will be the true type of the enum as a string, e.g. "ENamespacedEnum::InnerType" or "ERegularEnum" or "EEnumClass" |
|
|
EnumDisplayNameFn |
Pointer to function used to look up the enum's display name. |
|
|
EnumFlags |
Enum flags. |
|
|
Names |
List of pairs of all enum names and values. |
Name | Description | |
---|---|---|
|
UEnum ( |
DO NOT USE. This constructor is for internal usage only for hot-reload purposes. |
|
UEnum ( |
Name | Description | ||
---|---|---|---|
|
__DefaultConstructor ( |
||
|
UObject *... |
__VTableCtorCaller ( |
|
|
AddNamesToMasterList() |
Adds the Names in this enum to the master AllEnumNames list |
|
|
ContainsExistingMax() |
Tests if the enum contains a MAX value |
|
|
FindAuthoredNameStringByValue |
Looks for a display name with a given value and returns true and writes the unlocalized logical name to Out if one was found |
|
|
FindDisplayNameTextByValue |
Looks for a display name with a given value and returns true and writes the name to Out if one was found |
|
|
FindNameStringByValue |
Looks for a name with a given value and returns true and writes the name to Out if one was found |
|
|
GenerateEnumPrefix() |
Find the longest common prefix of all items in the enumeration. |
|
|
GenerateFullEnumName ( |
Generates full name including EnumName:: given enum name. |
|
|
GetAuthoredNameStringByIndex ( |
Returns the unlocalized logical name originally assigned to the enum at creation. |
|
|
GetAuthoredNameStringByValue ( |
Version of GetAuthoredNameByIndex that takes a value instead |
|
|
GetCppForm() |
Returns the type of enum: whether it's a regular enum, namespaced enum or C++11 enum class. |
|
|
GetDisplayNameTextByIndex ( |
Finds the localized display name or native display name as a fallback. |
|
|
GetDisplayNameTextByValue ( |
Version of GetDisplayNameTextByIndex that takes a value instead |
|
|
GetDisplayValueAsText ( |
||
|
GetDisplayValueAsText ( |
||
|
GetDisplayValueAsText |
||
|
GetDisplayValueAsText |
||
|
GetDisplayValueAsText ( |
||
|
GetDisplayValueAsText ( |
||
|
GetIndexByName ( |
Gets index of name in enum, returns INDEX_NONE and optionally errors when name is not found. |
|
|
GetIndexByNameString ( |
Gets index of name in enum, returns INDEX_NONE and optionally errors when name is not found. |
|
|
GetIndexByValue ( |
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. |
|
|
GetMaxEnumValue() |
Gets max value of Enum. Defaults to zero if there are no entries. |
|
|
GetMetaData |
Return the metadata value associated with the specified key. |
|
|
GetNameByIndex ( |
Gets enum name by index in Names array. Returns NAME_None if Index is not valid. |
|
|
GetNameByValue ( |
Gets enum name by value. Returns NAME_None if value is not found. |
|
|
GetNameStringByIndex ( |
Returns the short name at the enum index, returns empty string if invalid |
|
|
GetNameStringByValue ( |
Returns the short name matching the enum Value, returns empty string if invalid |
|
|
GetToolTipTextByIndex ( |
Finds the localized tooltip or native tooltip as a fallback. |
|
|
GetValueAsName ( |
||
|
GetValueAsName ( |
||
|
GetValueAsName |
||
|
GetValueAsString ( |
||
|
GetValueAsString ( |
||
|
GetValueAsString ( |
||
|
GetValueAsString |
||
|
GetValueAsString ( |
||
|
GetValueAsString |
||
|
GetValueByIndex ( |
Gets enum value by index in Names array. Asserts on invalid index |
|
|
GetValueByName ( |
Gets enum value by name, returns INDEX_NONE and optionally errors when name is not found. |
|
|
GetValueByNameString ( |
Gets enum value by name, returns INDEX_NONE and optionally errors when name is not found. |
|
|
HasAnyEnumFlags ( |
||
|
HasMetaData |
Wrapper method for easily determining whether this enum has metadata associated with it. |
|
|
IsFullEnumName ( |
Checks if a enum name is fully qualified name. |
|
|
IsValidEnumName ( |
Checks if enum has entry with given name. Includes autogenerated _MAX entry. |
|
|
IsValidEnumValue ( |
Checks if enum has entry with given value. Includes autogenerated _MAX entry. |
|
|
LookupEnumName |
Searches the list of all enum value names for the specified name |
|
|
LookupEnumNameSlow |
Searches the list of all enum value names for the specified name |
|
|
NumEnums() |
||
|
ParseEnum ( |
Parses the passed in string for a name, then searches for that name in any Enum (in any package) |
|
|
RemoveMetaData |
Remove given key meta data |
|
|
RemoveNamesFromMasterList() |
Removes the Names in this enum from the master AllEnumNames list |
|
|
ResolveEnumerator |
Try to update an out-of-date enum index after an enum changes at runtime |
|
|
SetEnumDisplayNameFn ( |
Associate a function for looking up Enum display names by index, only intended for use by generated code |
|
|
SetEnumFlags ( |
||
|
SetEnums |
Sets the array of enums. |
|
|
SetMetaData |
Set the metadata value associated with the specified key. |
|
|
UClass * |
StaticClass() |
Returns a UClass object representing this class at runtime |
|
EClassCastFl... |
StaticClassCastFlags() |
Returns the static cast flags for this class |
|
const TCHAR ... |
StaticPackage() |
Returns the package this class belongs in |
|
StaticRegisterNativesUEnum() |
Name | Description | ||
---|---|---|---|
|
operator delete ( |
Eliminate V1062 warning from PVS-Studio while keeping MSVC and Clang happy. |
|
|
void * |
operator new ( |
For internal use only; use StaticConstructObject() to create new objects. |
|
void * |
operator new ( |
For internal use only; use StaticConstructObject() to create new objects. |
Name |
Description |
|
---|---|---|
|
ECppForm |
How this enum is declared in C++, affects the internal naming of enum values |
Name |
Description |
---|---|
AllEnumNames |
Global list of all value names used by all enums in memory, used for property text import |
StaticClassFlags |
Bitwise union of EClassFlags pertaining to this class. |
Name | Description | ||
---|---|---|---|
|
FindEnumIndex ( |
FindEnumIndex is deprecated, call GetIndexByName or GetValueByName instead |
|
|
FindEnumRedirects |
FindEnumRedirects is deprecated, call GetIndexByNameString instead |
|
|
GetDisplayNameText ( |
GetDisplayNameText with name index is deprecated, call GetDisplayNameTextByIndex instead |
|
|
GetEnum ( |
GetEnum is deprecated, call GetNameByIndex instead |
|
|
GetEnumName ( |
GetEnumName is deprecated, call GetNameStringByIndex instead |
|
|
GetEnumNameStringByValue ( |
GetEnumNameStringByValue is deprecated, call GetNameStringByValue instead |
|
|
GetEnumText ( |
GetEnumText with name index is deprecated, call GetDisplayNameTextByIndex instead |
|
|
GetEnumTextByValue ( |
GetEnumTextByValue with name index is deprecated, call GetDisplayNameTextByValue instead |
|
|
GetToolTipText ( |
GetToolTipText with name index is deprecated, call GetToolTipTextByIndex instead |