1. Epic GamesDeveloper
  3. FEnumProperty

FEnumProperty

API > API/Runtime > API/Runtime/CoreUObject

   
Name FEnumProperty
Type class
Header File /Engine/Source/Runtime/CoreUObject/Public/UObject/EnumProperty.h
Include Path #include "UObject/EnumProperty.h"

Syntax

class FEnumProperty : public FProperty

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FEnumProperty ( FFieldVariant InOwner,
const UECodeGen_Private::FEnumPropertyParams& Prop
)

 Constructor used for constructing compiled in properties UObject/EnumProperty.h  

FEnumProperty ( FFieldVariant InOwner,
const FName& InName,
EObjectFlags InObjectFlags
)

   UObject/EnumProperty.h  

FEnumProperty ( EInternal InInernal,
FFieldClass* InClass
)

   UObject/EnumProperty.h  

FEnumProperty ( UField* InField
)

   UObject/EnumProperty.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FEnumProperty()

   UObject/EnumProperty.h  

Typedefs

Name Type Remarks Include Path
Super FProperty   UObject/EnumProperty.h
ThisClass FEnumProperty   UObject/EnumProperty.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Enum TObjectPtr< UEnum >   UObject/EnumProperty.h  
UnderlyingProp FNumericProperty *   UObject/EnumProperty.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UEnum * GetEnum()

 Returns a pointer to the UEnum of this property. UObject/EnumProperty.h  

uint64 GetMaxNetSerializeBits()

 Returns the number of bits required by NetSerializeItem to encode this enum, based on the maximum value. UObject/EnumProperty.h  

FNumericProperty * GetUnderlyingProperty()

 Returns the numeric property which represents the integral type of the enum. UObject/EnumProperty.h  

void SetEnum ( UEnum* InEnum
)

 Set the UEnum of this property. UObject/EnumProperty.h  

void SetEnumForImpersonation ( UEnum* InEnum
)

 Set the UEnum of this property. UObject/EnumProperty.h  

Overridden from FProperty

Name Remarks Include Path Unreal Specifiers

virtual void AppendSchemaHash ( FBlake3& Builder,
bool bSkipEditorOnly
) const

 Updates the given HashBuilder with name and type information of this Property. UObject/EnumProperty.h  

virtual bool CanSerializeFromTypeName ( UE::FPropertyTypeName Type
) const

 Returns true if the type of this property matches the type name. UObject/EnumProperty.h  

virtual EConvertFromTypeResult ConvertFromType ( const FPropertyTag& Tag,
FStructuredArchive::FSlot Slot,
uint8* Data,
const UStruct* DefaultsStruct,
const uint8* Defaults
)

 Allows a property to implement backwards compatibility handling for tagged properties UObject/EnumProperty.h  

virtual void ExportText_Internal ( FString& ValueStr,
const void* PropertyValueOrContainer,
EPropertyPointerType PropertyPointerType,
const void* DefaultValue,
UObject* Parent,
int32 PortFlags,
UObject* ExportRootScope
) const

   UObject/EnumProperty.h  

virtual FString GetCPPMacroType ( FString& ExtendedTypeText
) const

   UObject/EnumProperty.h  

virtual FString GetCPPType ( FString* ExtendedTypeText,
uint32 CPPExportFlags
) const

 Returns the text to use for exporting this property to header file. UObject/EnumProperty.h  

virtual int32 GetMinAlignment()

   UObject/EnumProperty.h  
Returns whether this type has a special state for an unset TOptional meaning the size TOptional and T are the same. UObject/EnumProperty.h  

virtual bool Identical ( const void* A,
const void* B,
uint32 PortFlags
) const

 Determines whether the property values are identical. UObject/EnumProperty.h  

virtual const TCHAR * ImportText_Internal ( const TCHAR* Buffer,
void* ContainerOrPropertyPtr,
EPropertyPointerType PropertyPointerType,
UObject* OwnerObject,
int32 PortFlags,
FOutputDevice* ErrorText
) const

   UObject/EnumProperty.h  

virtual void LinkInternal ( FArchive& Ar
)

   UObject/EnumProperty.h  

virtual bool LoadTypeName ( UE::FPropertyTypeName Type,
const FPropertyTag* Tag
)

 Restores this property and its owned properties from the type name. UObject/EnumProperty.h  

virtual bool NetSerializeItem ( FArchive& Ar,
UPackageMap* Map,
void* Data,
TArray< uint8 >* MetaData
) const

   UObject/EnumProperty.h  

virtual bool SameType ( const FProperty* Other
) const

 Returns true, if Other is property of exactly the same type UObject/EnumProperty.h  

virtual void SaveTypeName ( UE::FPropertyTypeNameBuilder& Type
) const

 Saves the type name of this property and its owned properties. UObject/EnumProperty.h  

virtual void SerializeItem ( FStructuredArchive::FSlot Slot,
void* Value,
void const* Defaults
) const

   UObject/EnumProperty.h  

Overridden from FField

Name Remarks Include Path Unreal Specifiers

virtual void AddCppProperty ( FProperty* Property
)

   UObject/EnumProperty.h  

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   UObject/EnumProperty.h  

virtual SIZE_T GetFieldSize()

   UObject/EnumProperty.h  

virtual FField * GetInnerFieldByName ( const FName& InName
)

 Returns an inner field by name if the field has any UObject/EnumProperty.h  

virtual void GetInnerFields ( TArray< FField* >& OutFields
)

 Fills the provided array with all inner fields this field owns (recursively) UObject/EnumProperty.h  

virtual void GetPreloadDependencies ( TArray< UObject* >& OutDeps
)

   UObject/EnumProperty.h  

virtual void PostDuplicate ( const FField& InField
)

 Fixups after duplicating a Field UObject/EnumProperty.h  

virtual void Serialize ( FArchive& Ar
)

 Begin UObject interface: the following functions mimic UObject interface for easier transition from UProperties to FProperties. UObject/EnumProperty.h  

Static

Name Remarks Include Path Unreal Specifiers

static FField * Construct ( const FFieldVariant& InOwner,
const FName& InName,
EObjectFlags InObjectFlags
)

   UObject/EnumProperty.h  

static FFieldClass * StaticClass()

   UObject/EnumProperty.h  

static EClassCastFlags StaticClassCastFlags()

   UObject/EnumProperty.h  

static EClassCastFlags StaticClassCastFlagsPrivate()

   UObject/EnumProperty.h  

Operators

Name Remarks Include Path Unreal Specifiers

void operator delete ( void* InMem
)

   UObject/EnumProperty.h  

void * operator new ( const size_t InSize,
void* InMem
)

   UObject/EnumProperty.h  

void * operator new ( const size_t InSize
)

   UObject/EnumProperty.h  
  UObject/EnumProperty.h  
  UObject/EnumProperty.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page