Field.h File Reference

#include "Containers/Array.h"
#include "Containers/LinkedListBuilder.h"
#include "Containers/Map.h"
#include "Containers/StringFwd.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
#include "HAL/PlatformMath.h"
#include "HAL/PreprocessorHelpers.h"
#include "HAL/UnrealMemory.h"
#include "Internationalization/Text.h"
#include "Math/RandomStream.h"
#include "Misc/AssertionMacros.h"
#include "Misc/CString.h"
#include "Misc/EnumClassFlags.h"
#include "Misc/Guid.h"
#include "Misc/Optional.h"
#include "Serialization/Archive.h"
#include "Serialization/StructuredArchive.h"
#include "Serialization/StructuredArchiveAdapters.h"
#include "Serialization/StructuredArchiveSlots.h"
#include "Templates/EnableIf.h"
#include "Templates/IsAbstract.h"
#include "Templates/IsEnum.h"
#include "Templates/NoDestroy.h"
#include "Templates/Requires.h"
#include "Templates/TypeHash.h"
#include "Templates/UnrealTemplate.h"
#include "Templates/UnrealTypeTraits.h"
#include "UObject/CoreNative.h"
#include "UObject/GarbageCollection.h"
#include "UObject/NameTypes.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/PersistentObjectPtr.h"
#include "UObject/Script.h"
#include "UObject/SparseDelegate.h"
#include "UObject/UObjectGlobals.h"
#include "UObject/UnrealNames.h"
#include "UObject/WeakObjectPtr.h"
#include <type_traits>

Go to the source code of this file.

Classes
class	FFieldClass
class	FFieldVariant
class	FField

Macros
#define	DECLARE_FIELD_NEW_IMPLEMENTATION(TClass)
#define	UE_DEFINE_GET_FIELD_CLASS_PRIVATE
#define	UE_DECLARE_FIELD_CLASS_STATIC_CONSTINIT
#define	UE_DEFINE_FIELD_CLASS_STATIC_CONSTINIT(...)
#define	DECLARE_FIELD(TClass, TSuperClass, TStaticFlags)    DECLARE_FIELD_API(TClass, TSuperClass, TStaticFlags, NO_API)
#define	DECLARE_FIELD_API(TClass, TSuperClass, TStaticFlags, TRequiredAPI)
#define	IMPLEMENT_FIELD_CONSTRUCT_IMPLEMENTATION(TClass)
#define	IMPLEMENT_FIELD(TClass)

Functions
template<typename FieldType >
UE_FORCEINLINE_HINT FieldType *	CastField (FField *Src)
template<typename FieldType >
UE_FORCEINLINE_HINT const FieldType *	CastField (const FField *Src)
template<typename FieldType >
UE_FORCEINLINE_HINT FieldType *	ExactCastField (FField *Src)
template<typename FieldType >
UE_FORCEINLINE_HINT FieldType *	ExactCastField (const FField *Src)
template<typename FieldType >
FUNCTION_NON_NULL_RETURN_START FieldType *	CastFieldChecked (FField *Src) FUNCTION_NON_NULL_RETURN_END
template<typename FieldType >
FUNCTION_NON_NULL_RETURN_START const FieldType *	CastFieldChecked (const FField *Src) FUNCTION_NON_NULL_RETURN_END
template<typename FieldType >
FieldType *	CastFieldCheckedNullAllowed (FField *Src)
template<typename FieldType >
const FieldType *	CastFieldCheckedNullAllowed (const FField *Src)
template<typename FieldType >
void	SerializeSingleField (FArchive &Ar, FieldType *&Field, FFieldVariant Owner)
FName	GetFNameSafe (const FField *InField)
FString	GetNameSafe (const FField *InField)
COREUOBJECT_API FString	GetFullNameSafe (const FField *InField)
COREUOBJECT_API FString	GetPathNameSafe (const FField *InField, const UObject *StopOuter=nullptr)
COREUOBJECT_API FField *	FindFPropertyByPath (const TCHAR *InFieldPath)
template<typename FieldType >
FieldType *	FindFProperty (const TCHAR *InFieldPath)

Macro Definition Documentation

DECLARE_FIELD

#define DECLARE_FIELD	(		TClass,
			TSuperClass,
			TStaticFlags
	)		DECLARE_FIELD_API(TClass, TSuperClass, TStaticFlags, NO_API)

DECLARE_FIELD_API

#define DECLARE_FIELD_API	(		TClass,
			TSuperClass,
			TStaticFlags,
			TRequiredAPI
	)

DECLARE_FIELD_NEW_IMPLEMENTATION

#define DECLARE_FIELD_NEW_IMPLEMENTATION

(

TClass

)

Value:

        ThisClass* Mem = (ThisClass*)FMemory::Malloc(InSize); \
		new (Mem) TClass(EC_InternalUseOnlyConstructor, TClass::StaticClass()); \
        return Mem;

IMPLEMENT_FIELD

#define IMPLEMENT_FIELD

(

TClass

)

Value:

FField* TClass::Construct(const FFieldVariant& InOwner, const FName& InName, EObjectFlags InFlags) \
{ \
	IMPLEMENT_FIELD_CONSTRUCT_IMPLEMENTATION(TClass) \
} \
FFieldClass* TClass::StaticClass() \
{ \
    static FFieldClass StaticFieldClass(TEXT(PREPROCESSOR_TO_STRING(TClass)), TClass::StaticClassCastFlagsPrivate(), TClass::StaticClassCastFlags(), TClass::Super::StaticClass(), &TClass::Construct); \
    return &StaticFieldClass; \
}

IMPLEMENT_FIELD_CONSTRUCT_IMPLEMENTATION

#define IMPLEMENT_FIELD_CONSTRUCT_IMPLEMENTATION

(

TClass

)

Value:

        FField* Instance = new TClass(InOwner, InName, InFlags); \
        return Instance;

UE_DECLARE_FIELD_CLASS_STATIC_CONSTINIT

#define UE_DECLARE_FIELD_CLASS_STATIC_CONSTINIT

UE_DEFINE_FIELD_CLASS_STATIC_CONSTINIT

#define UE_DEFINE_FIELD_CLASS_STATIC_CONSTINIT

(

...

)

UE_DEFINE_GET_FIELD_CLASS_PRIVATE

#define UE_DEFINE_GET_FIELD_CLASS_PRIVATE

Function Documentation

CastField() [1/2]

template<typename FieldType >

UE_FORCEINLINE_HINT const FieldType * CastField

(

const FField *

Src

)

CastField() [2/2]

template<typename FieldType >

UE_FORCEINLINE_HINT FieldType * CastField

(

FField *

Src

)

CastFieldChecked() [1/2]

template<typename FieldType >

FUNCTION_NON_NULL_RETURN_START const FieldType * CastFieldChecked ( const FField *  Src )

inline

CastFieldChecked() [2/2]

template<typename FieldType >

FUNCTION_NON_NULL_RETURN_START FieldType * CastFieldChecked ( FField *  Src )

inline

CastFieldCheckedNullAllowed() [1/2]

template<typename FieldType >

const FieldType * CastFieldCheckedNullAllowed ( const FField *  Src )

inline

CastFieldCheckedNullAllowed() [2/2]

template<typename FieldType >

FieldType * CastFieldCheckedNullAllowed ( FField *  Src )

inline

ExactCastField() [1/2]

template<typename FieldType >

UE_FORCEINLINE_HINT FieldType * ExactCastField

(

const FField *

Src

)

ExactCastField() [2/2]

template<typename FieldType >

UE_FORCEINLINE_HINT FieldType * ExactCastField

(

FField *

Src

)

FindFProperty()

template<typename FieldType >

FieldType * FindFProperty ( const TCHAR *  InFieldPath )

inline

Templated version of FindFieldByPath

FindFPropertyByPath()

COREUOBJECT_API FField * FindFPropertyByPath

(

const TCHAR *

InFieldPath

)

Finds a field given a path to the field (Package.Class[:Subobject:...]:FieldName)

GetFNameSafe()

FName GetFNameSafe ( const FField *  InField )

inline

Gets the name of the provided field. If the field pointer is null, the result is "none"

GetFullNameSafe()

COREUOBJECT_API FString GetFullNameSafe

(

const FField *

InField

)

Gets the full name of the provided field. If the field pointer is null, the result is "none"

GetNameSafe()

FString GetNameSafe ( const FField *  InField )

inline

Gets the name of the provided field. If the field pointer is null, the result is "none"

GetPathNameSafe()

COREUOBJECT_API FString GetPathNameSafe	(	const FField *	InField,
		const UObject *	StopOuter = nullptr
	)

Gets the path name of the provided field. If the field pointer is null, the result is "none"

SerializeSingleField()

template<typename FieldType >

void SerializeSingleField ( FArchive &  Ar, FieldType *&  Field, FFieldVariant  Owner  )

inline

Helper function for serializing FField to an archive. This function fully serializes the field and its properties.