UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FFieldVariant Class Reference

#include <Field.h>

+ Inheritance diagram for FFieldVariant:

Public Member Functions

constexpr FFieldVariant ()
 
 FFieldVariant (const FField *InField)
 
template<typename T >
 FFieldVariant (T &&InObject)
 
constexpr FFieldVariant (TYPE_OF_NULLPTR)
 
constexpr FFieldVariant (const FFieldVariant &Other)
 
constexpr FFieldVariantoperator= (const FFieldVariant &Other)
 
constexpr FFieldVariant (FFieldVariant &&Other)
 
constexpr FFieldVariantoperator= (FFieldVariant &&Other)
 
bool IsUObject () const
 
bool IsValid () const
 
COREUOBJECT_API bool IsValidLowLevel () const
 
 operator bool () const
 
COREUOBJECT_API bool IsA (const UClass *InClass) const
 
COREUOBJECT_API bool IsA (const FFieldClass *InClass) const
 
template<typename T >
bool IsA () const
 
template<typename T >
T * Get () const
 
UObjectToUObject () const
 
FFieldToField () const
 
UE_FORCEINLINE_HINT FFieldToFieldUnsafe () const
 
UE_FORCEINLINE_HINT UObjectToUObjectUnsafe () const
 
voidGetRawPointer () const
 
COREUOBJECT_API FFieldVariant GetOwnerVariant () const
 
COREUOBJECT_API UClassGetOwnerClass () const
 
COREUOBJECT_API FString GetFullName () const
 
COREUOBJECT_API FString GetPathName () const
 
COREUOBJECT_API FString GetName () const
 
COREUOBJECT_API FString GetClassName () const
 
COREUOBJECT_API FName GetFName () const
 
COREUOBJECT_API bool IsNative () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
bool operator== (const FFieldVariant &Other) const
 
bool operator!= (const FFieldVariant &Other) const
 

Friends

uint32 GetTypeHash (const FFieldVariant &InFieldVariant)
 

Detailed Description

Special container that can hold either UObject or FField. Exposes common interface of FFields and UObjects for easier transition from UProperties to FProperties. DO NOT ABUSE. IDEALLY THIS SHOULD ONLY BE FFIELD INTERNAL STRUCTURE FOR HOLDING A POINTER TO THE OWNER OF AN FFIELD.

Constructor & Destructor Documentation

◆ FFieldVariant() [1/6]

constexpr FFieldVariant::FFieldVariant ( )
inlineconstexpr

◆ FFieldVariant() [2/6]

FFieldVariant::FFieldVariant ( const FField InField)
inline

◆ FFieldVariant() [3/6]

template<typename T >
FFieldVariant::FFieldVariant ( T &&  InObject)
inline

◆ FFieldVariant() [4/6]

constexpr FFieldVariant::FFieldVariant ( TYPE_OF_NULLPTR  )
inlineconstexpr

◆ FFieldVariant() [5/6]

constexpr FFieldVariant::FFieldVariant ( const FFieldVariant Other)
inlineconstexpr

◆ FFieldVariant() [6/6]

constexpr FFieldVariant::FFieldVariant ( FFieldVariant &&  Other)
inlineconstexpr

Member Function Documentation

◆ Get()

template<typename T >
T * FFieldVariant::Get ( ) const
inline

◆ GetClassName()

FString FFieldVariant::GetClassName ( ) const

◆ GetFName()

FName FFieldVariant::GetFName ( ) const

◆ GetFullName()

FString FFieldVariant::GetFullName ( ) const

◆ GetName()

FString FFieldVariant::GetName ( ) const

◆ GetOutermost()

UPackage * FFieldVariant::GetOutermost ( ) const

◆ GetOwnerClass()

UClass * FFieldVariant::GetOwnerClass ( ) const

◆ GetOwnerVariant()

FFieldVariant FFieldVariant::GetOwnerVariant ( ) const

◆ GetPathName()

FString FFieldVariant::GetPathName ( ) const

◆ GetRawPointer()

void * FFieldVariant::GetRawPointer ( ) const
inline

◆ IsA() [1/3]

template<typename T >
bool FFieldVariant::IsA ( ) const
inline

◆ IsA() [2/3]

bool FFieldVariant::IsA ( const FFieldClass InClass) const

◆ IsA() [3/3]

bool FFieldVariant::IsA ( const UClass InClass) const

◆ IsNative()

bool FFieldVariant::IsNative ( ) const

◆ IsUObject()

bool FFieldVariant::IsUObject ( ) const
inline

◆ IsValid()

bool FFieldVariant::IsValid ( ) const
inline

◆ IsValidLowLevel()

bool FFieldVariant::IsValidLowLevel ( ) const

◆ operator bool()

FFieldVariant::operator bool ( ) const
inline

◆ operator!=()

bool FFieldVariant::operator!= ( const FFieldVariant Other) const
inline

◆ operator=() [1/2]

constexpr FFieldVariant & FFieldVariant::operator= ( const FFieldVariant Other)
inlineconstexpr

◆ operator=() [2/2]

constexpr FFieldVariant & FFieldVariant::operator= ( FFieldVariant &&  Other)
inlineconstexpr

◆ operator==()

bool FFieldVariant::operator== ( const FFieldVariant Other) const
inline

◆ ToField()

FField * FFieldVariant::ToField ( ) const
inline

◆ ToFieldUnsafe()

UE_FORCEINLINE_HINT FField * FFieldVariant::ToFieldUnsafe ( ) const
inline

FOR INTERNAL USE ONLY: Function that returns the owner as FField without checking if it's actually an FField

◆ ToUObject()

UObject * FFieldVariant::ToUObject ( ) const
inline

◆ ToUObjectUnsafe()

UE_FORCEINLINE_HINT UObject * FFieldVariant::ToUObjectUnsafe ( ) const
inline

FOR INTERNAL USE ONLY: Function that returns the owner as UObject without checking if it's actually a UObject

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FFieldVariant InFieldVariant)
friend

Support comparison functions that make this usable as a KeyValue for a TSet<>


The documentation for this class was generated from the following files: