UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FOverridableSerializationLogic Struct Reference

#include <OverriddenPropertySet.h>

Public Types

enum class  ECapabilities : uint32 { None = 0 , T3DSerialization = 1 << 0 , SubObjectsShadowSerialization = 1 << 1 , All = T3DSerialization | SubObjectsShadowSerialization }
 

Static Public Member Functions

static void Enable (FOverriddenPropertySet *InOverriddenProperties)
 
static void Disable ()
 
static bool IsEnabled ()
 
static COREUOBJECT_API bool HasCapabilities (ECapabilities InCapabilities)
 
static FOverriddenPropertySetGetOverriddenProperties ()
 
static COREUOBJECT_API FOverriddenPropertySetGetOverriddenPropertiesSlow ()
 
static COREUOBJECT_API EOverriddenPropertyOperation GetOverriddenPropertyOperation (const FArchive &Ar, FProperty *Property=nullptr, uint8 *DataPtr=nullptr, const uint8 *DefaultValue=nullptr)
 
static COREUOBJECT_API EOverriddenPropertyOperation GetOverriddenPropertyOperationForPortText (const void *DataPtr, const void *DefaultValue, int32 PortFlags)
 
static COREUOBJECT_API FPropertyVisitorPathGetOverriddenPortTextPropertyPath ()
 
static COREUOBJECT_API void SetOverriddenPortTextPropertyPath (FPropertyVisitorPath &Path)
 
static COREUOBJECT_API void ResetOverriddenPortTextPropertyPath ()
 
static COREUOBJECT_API bool ShouldPropertyShadowSerializeSubObject (TNotNull< const FProperty * > Property)
 

Friends

struct FOverridableSerializationLogicInternalAdapter
 

Member Enumeration Documentation

◆ ECapabilities

Enumerator
None 
T3DSerialization 
SubObjectsShadowSerialization 
All 

Member Function Documentation

◆ Disable()

static void FOverridableSerializationLogic::Disable ( )
inlinestatic

Call to disable overridable serialization Note this is not re-entrant and it stores information in a thread local storage

◆ Enable()

static void FOverridableSerializationLogic::Enable ( FOverriddenPropertySet InOverriddenProperties)
inlinestatic

Call to enable overridable serialization and to set the overridden properties of the current serialized object Note this is not re-entrant and it stores information in a thread local storage

Parameters
InOverriddenPropertiesof the current serializing object

◆ GetOverriddenPortTextPropertyPath()

FPropertyVisitorPath * FOverridableSerializationLogic::GetOverriddenPortTextPropertyPath ( )
static

Call during the import text

Returns
the current text import property path

◆ GetOverriddenProperties()

static FOverriddenPropertySet * FOverridableSerializationLogic::GetOverriddenProperties ( )
inlinestatic

Call during the serialization of an object to get its overriden properties Note: Expects the current serialized object to use overridable serialization Note this is not re-entrant and it stores information in a thread local storage

Returns
the overridden properties of the current object being serialized

◆ GetOverriddenPropertiesSlow()

FOverriddenPropertySet * FOverridableSerializationLogic::GetOverriddenPropertiesSlow ( )
static

Call during the serialization of an object to get its overriden properties Note: Expects the current serialized object to use overridable serialization Note this is not re-entrant and it stores information in a thread local storage

Returns
the overridden properties of the current object being serialized

◆ GetOverriddenPropertyOperation()

EOverriddenPropertyOperation FOverridableSerializationLogic::GetOverriddenPropertyOperation ( const FArchive Ar,
FProperty Property = nullptr,
uint8 DataPtr = nullptr,
const uint8 DefaultValue = nullptr 
)
static

Retrieve from the Archive and the current property the overridden property operation to know if it has to be serialized or not

Parameters
Arcurrently being used to serialize the current object (will be used to retrieve the current property serialized path)
Propertythe property about to be serialized, can be null
DataPtrto the memory of that property
DefaultValuememory pointer of that property
Returns
the overridden property operation

◆ GetOverriddenPropertyOperationForPortText()

EOverriddenPropertyOperation FOverridableSerializationLogic::GetOverriddenPropertyOperationForPortText ( const void DataPtr,
const void DefaultValue,
int32  PortFlags 
)
static

Use the port text path to retrieve the current overridden property operation to know if it has to be serialized or not

Parameters
DataPtrto the memory of that property
DefaultValuememory pointer of that property
PortFlagsfor the import/export text operation
Returns
the overridden property operation

◆ HasCapabilities()

bool FOverridableSerializationLogic::HasCapabilities ( ECapabilities  InCapabilities)
static

Used to enable override features selectively during development Capabilities driven by CVars

◆ IsEnabled()

static bool FOverridableSerializationLogic::IsEnabled ( )
inlinestatic

Called during the serialization of an object to know to know if it should do overridden serialization logic

Returns
true if the overridable serialization is enabled on the current serializing object

◆ ResetOverriddenPortTextPropertyPath()

void FOverridableSerializationLogic::ResetOverriddenPortTextPropertyPath ( )
static

Call during the import text to reset property path

◆ SetOverriddenPortTextPropertyPath()

void FOverridableSerializationLogic::SetOverriddenPortTextPropertyPath ( FPropertyVisitorPath Path)
static

Call during the import text to set the property path

Parameters
Pathto start tracking the property path

◆ ShouldPropertyShadowSerializeSubObject()

bool FOverridableSerializationLogic::ShouldPropertyShadowSerializeSubObject ( TNotNull< const FProperty * >  Property)
static

To know if the specified property should shadow serialize its values for OS

Friends And Related Symbol Documentation

◆ FOverridableSerializationLogicInternalAdapter


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