FEnumProperty

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FProperty

FProperty

FEnumProperty

References

Module

CoreUObject

Header

/Engine/Source/Runtime/CoreUObject/Public/UObject/EnumProperty.h

Include

#include "UObject/EnumProperty.h"

Syntax

class FEnumProperty :
    public FProperty,
    public FProperty

Constructors

Name Description

Public function

FEnumProperty

(
    UField* InField
)

Public function

FEnumProperty

(
    const FObjectInitializer& ObjectIn...
)

Public function

FEnumProperty

(
    FVTableHelper& Helper
)

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

Public function

FEnumProperty

(
    EInternal InInernal,
    FFieldClass* InClass
)

Public function

FEnumProperty

(
    const FObjectInitializer& ObjectIn...,
    UEnum* InEnum
)

Public function

FEnumProperty

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

Public function

FEnumProperty

(
    FFieldVariant InOwner,
    const FName& InName,
    EObjectFlags InObjectFlags,
    UEnum* InEnum
)

Public function

FEnumProperty

(
    const FObjectInitializer& ObjectIn...,
    ECppProperty,
    int32 InOffset,
    EPropertyFlags InFlags,
    UEnum* InEnum
)

Public function

FEnumProperty

(
    FFieldVariant InOwner,
    const FName& InName,
    EObjectFlags InObjectFlags,
    int32 InOffset,
    EPropertyFlags InFlags,
    UEnum* InEnum
)

Destructors

Name Description

Public function Virtual

~FEnumProperty()

Functions

Name Description

Public function Static

void

 

__DefaultConstructor

(
    const FObjectInitializer& X
)

Public function Static

UObject *...

 

__VTableCtorCaller

(
    FVTableHelper& Helper
)

Public function Static

void

 

AddReferencedObjects

(
    UObject* InThis,
    FReferenceCollector& Collector
)

Public function Static

FField *

 

Construct

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

Public function Const

UEnum *

 

GetEnum()

Returns a pointer to the UEnum of this property.

Public function Const

uint64

 

GetMaxNetSerializeBits()

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

Public function Const

FNumericProp...

 

GetUnderlyingProperty()

Returns the numeric property which represents the integral type of the enum.

Public function

void

 

SetEnum

(
    UEnum* InEnum
)

Set the UEnum of this property.

Public function Static

FFieldClass ...

 

StaticClass()

Public function Static

UClass *

 

StaticClass()

Returns a UClass object representing this class at runtime

Public function Static

uint64

 

StaticClassCastFlags()

Public function Static

EClassCastFl...

 

StaticClassCastFlags()

Returns the static cast flags for this class

Public function Static

uint64

 

StaticClassCastFlagsPrivate()

Public function Static

const TCHAR ...

 

StaticPackage()

Returns the package this class belongs in

Public function Static

void

 

StaticRegisterNativesFEnumProperty()

Overridden from FProperty

Name Description

Public function Virtual Const

void

 

AppendSchemaHash

(
    FBlake3& Builder,
    bool bSkipEditorOnly
)

Updates the given HashBuilder with name and type information of this Property.

Public function Virtual

EConvertFrom...

 

ConvertFromType

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

Allows a property to implement backwards compatibility handling for tagged properties

Public function Virtual Const

void

 

ExportTextItem

(
    FString& ValueStr,
    const void* PropertyValue,
    const void* DefaultValue,
    UObject* Parent,
    int32 PortFlags,
    UObject* ExportRootScope
)

Public function Virtual Const

FString

 

GetCPPMacroType

(
    FString& ExtendedTypeText
)

Public function Virtual Const

FString

 

GetCPPType

(
    FString* ExtendedTypeText,
    uint32 CPPExportFlags
)

Returns the text to use for exporting this property to header file.

Public function Virtual Const

FString

 

GetCPPTypeForwardDeclaration()

Public function Virtual Const

int32

 

GetMinAlignment()

Public function Virtual Const

bool

 

Identical

(
    const void* A,
    const void* B,
    uint32 PortFlags
)

Determines whether the property values are identical.

Public function Virtual Const

const TCHAR ...

 

ImportText_Internal

(
    const TCHAR* Buffer,
    void* Data,
    int32 PortFlags,
    UObject* OwnerObject,
    FOutputDevice* ErrorText
)

Public function Virtual

void

 

LinkInternal

(
    FArchive& Ar
)

Public function Virtual Const

bool

 

NetSerializeItem

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

Public function Virtual Const

bool

 

SameType

(
    const FProperty* Other
)

Returns true, if Other is property of exactly the same type

Public function Virtual Const

void

 

SerializeItem

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

Overridden from UField

Name Description

Public function Virtual

void

 

AddCppProperty

(
    FProperty* Property
)

Overridden from UObject

Name Description

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Overridden from FField

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

Public function Virtual

FField *

 

GetInnerFieldByName

(
    const FName& InName
)

Returns an inner field by name if the field has any

Public function Virtual

void

 

GetInnerFields

(
    TArray< FField* >& OutFields
)

Fills the provided array with all inner fields this field owns (recursively)

Public function Virtual

void

 

GetPreloadDependencies

(
    TArray< UObject* >& OutDeps
)

Public function Virtual

void

 

PostDuplicate

(
    const FField& InField
)

Fixups after duplicating a Field

Operators

Name Description

Public function

void

 

operator delete

(
    void* InMem
)

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
)

Public function

void *

 

operator new

(
    const size_t InSize,
    EInternal* InMem
)

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

Public function

void *

 

operator new

(
    const size_t InSize,
    void* InMem
)

Typedefs

Name

Description

Super

Typedef for the base class (FProperty)

Super

ThisClass

ThisClass

Typedef for FEnumProperty.

Constants

Name

Description

StaticClassFlags

Bitwise union of EClassFlags pertaining to this class.