Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UUserDefinedEnum

User defined enumerations:

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UField

UEnum

UUserDefinedEnum

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Engine/UserDefinedEnum.h
Include	#include "Engine/UserDefinedEnum.h"

Syntax

class UUserDefinedEnum : public UEnum

Remarks

User defined enumerations:

EnumType is always UEnum::ECppForm::Namespaced (to comfortable handle names collisions)
always have the last '_MAX' enumerator, that cannot be changed by user
Full enumerator name has form: '<enumeration path>="">::<short, user defined enumerator name>' An Enumeration is a list of named values.

Variables

	Name	Description
TMap< FName, FT...	DisplayNameMap	De-facto display names for enum entries mapped against their raw enum name (UEnum::GetNameByIndex).
FText	EnumDescription	Shows up in the content browser when the enum asset is hovered
uint32	UniqueNameIndex

Constructors

	Name	Description
	UUserDefinedEnum ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	FString	GenerateNewEnumeratorName()

Overridden from UEnum

	Name	Description
FString	GenerateFullEnumName ( const TCHAR* InEnumName )	Generates full enum name give enum name.
FString	GetAuthoredNameStringByIndex ( int32 InIndex )	Returns the unlocalized logical name originally assigned to the enum at creation.
FText	GetDisplayNameTextByIndex ( int32 InIndex )	Overridden to read DisplayNameMap
int64	ResolveEnumerator ( FArchive& Ar, int64 EnumeratorValue )	Try to update value in enum variable after an enum's change.
bool	SetEnums ( TArray< TPair< FName, int64 >>& In..., ECppForm InCppForm, EEnumFlags InFlags, bool bAddMaxKeyIfMissing )	Sets the array of enums.

Overridden from UObject

	Name	Description
void	GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )	Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostEditUndo()	Called after applying a transaction to the object.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
bool	Rename ( const TCHAR* NewName, UObject* NewOuter, ERenameFlags Flags )	Rename this object to a unique name, or change its outer.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss