className: FOptions

code: struct FOptions

bExcludeTail

description: When set, trace data buffered before starting tracing will not be output to the trace file

bNoWorkerThread

description: When set, trace will not start a worker thread, instead it is updated from end frame delegate.

bTruncateFile

description: When set, the target file will be truncated if it already exists.


description: Returns the current connection type.

module: Core


description: Returns the destination string that is currently being traced to. Contains either a file path or network address. Points to an empty string if tracing is disabled.

code: static const TCHAR * GetTraceDestination()


description: Initialize Trace systems.

code: static void Initialize ( const TCHAR * CommandLine )


description: Returns the destination string that is currently being traced to. Contains either a file path or network address. Empty if tracing is disabled.


description: Initialize channels that use the config driven presets.

code: static void InitializePresets ( const TCHAR * CommandLine )


description: Returns whether the trace system is currently connected to a trace sink (file or network)

code: static bool IsConnected()


description:
Returns whether the trace system is currently connected. If connected writes the session/trace identifiers.
True if connected

code: static bool IsConnected ( [FGuid](API\Runtime\Core\Misc\FGuid) & OutSessionGuid, [FGuid](API\Runtime\Core\Misc\FGuid) & OutTraceGuid )


className: OnConnection

description: This is an advanced feature to avoid using important events in cases where event data can be recalled easily.

code: static FOnConnection OnConnection;


className: OnSnapshotSaved

description: Delegate that triggers when a snapshot has been saved. The path to the snapshot file is passed to the delegate.


className: OnTraceStarted

description: Delegate that triggers when a trace session is started. The type of recording and the destination (filepath or network) is passed to the delegate.

code: static FOnTraceStarted OnTraceStarted;


className: OnTraceStopped

description: Delegate that triggers when a trace has finished recording. Useful if you need to collect all completed trace files in a session. The type of recording and the destination (filepath or network) is passed to the delegate.

code: static FOnTraceStopped OnTraceStopped;


description: Pause all tracing by disabling all active channels.

code: static bool Pause()


description: Used when process is panicking. Stops all tracing immediately to avoid further allocations. Process is not expected to continue after this call.

code: static void Panic()


description: Write tailing memory state to a trace server.

code: static bool SendSnapshot ( const TCHAR * Host, uint32 Port )


description: Resume tracing by enabling all previously active channels.

code: static bool Resume()


description: Shut down Trace systems.

code: static void Shutdown()


description:
Start tracing to a target (network connection or file) with an active set of channels. If a connection is already active this call does nothing.
True when successfully starting the trace, false if the data connection could not be made.

code: static bool Start ( [EConnectionType](API\Runtime\Core\ProfilingDebugging\FTraceAuxiliary\EConnectionType) Type, const TCHAR * Target, const TCHAR * Channels, [FOptions](API\Runtime\Core\ProfilingDebugging\FTraceAuxiliary\FOptions) * Options, const [FLogCategoryAlias](API\Runtime\Core\ProfilingDebugging\FTraceAuxiliary\FLogCategoryAlias) & LogCategory )


description:
Stop tracing.
True if the trace was stopped, false if there was no data connection.

code: static bool Stop()


description: Attempts to auto connect to an active trace server if an active session of Unreal Insights Session Browser is running.

code: static void TryAutoConnect()


className: FTraceAuxiliary

code: class FTraceAuxiliary


description: Write tailing memory state to a utrace file.

code: static bool WriteSnapshot ( const TCHAR * FilePath )


description: Free

code: virtual void Free ( void * Original )


description: Malloc

code: virtual void * Malloc ( SIZE_T Count, uint32 Alignment )


description: Notifies the malloc implementation that initialization of all allocators in GMalloc is complete, so it's safe to initialize any extra features that require "regular" allocations

code: virtual void OnMallocInitialized()


description: Notifies the malloc implementation that the process has forked so we can try and avoid dirtying pre-fork pages.

code: virtual void OnPostFork()


description: Notifies the malloc implementation that the process is about to fork. May be used to trim caches etc.

code: virtual void OnPreFork()


description: Realloc

code: virtual void * Realloc ( void * Original, SIZE_T Count, uint32 Alignment )


description: Deprecated* ShouldTrace is deprecated. Details should be internal now.

code: static bool ShouldTrace()


code: FTraceMalloc ( [FMalloc](API\Runtime\Core\HAL\FMalloc) * InMalloc )


code: static void EncodeZigZag ( int64 Value, uint8 *& BufferPtr )


code: static void Encode7bit ( uint64 Value, uint8 *& BufferPtr )


className: FAllocType

code: typedef typename FModifier::FAllocType FAllocType


className: FFilterType

code: typedef typename FAllocOp::FFilterType FFilterType


code: void Load ( [FString](API\Runtime\Core\Containers\FString) & Filename )


code: template<typename... ArgTypes> TAllocPlaybackLog ( [FFilterType](API\Runtime\Core\ProfilingDebugging\TAllocPlaybackLog\FFilterType) InFilter, ArgTypes &&... Args )


className: TAllocPlaybackLog

description: static void HandleFatalError(const TCHAR* Message); static void HandleErrorMessage(const TCHAR* Message); };

code: template<typename FModifier, typename FAllocOp> class TAllocPlaybackLog : public FModifier

CurrentFilter

type: FFilterType

Ops

type: TArray< FAllocO...


className: FTraceMalloc

code: class FTraceMalloc : public [FMalloc](API\Runtime\Core\HAL\FMalloc)

WrappedMalloc

type: FMalloc*


code: template<typename... ArgTypes> int64 RecordAlloc ( ArgTypes &&... Args )


code: void RecordFree ( int64 AllocIndex )


code: void WriteLineBuffer ( int32 NumCharacters )


code: template<typename... ArgTypes> TAllocRecordingLog ( const [FString](API\Runtime\Core\Containers\FString) & Filename, ArgTypes &&... Args )


className: TAllocRecordingLog

description: static void HandleDisplayMessage(const TCHAR* Message); };

code: template<typename FModifier, typename FAllocOp> class TAllocRecordingLog : public FModifier

CS

type: FCriticalSectio...

OutputFile

type: TSharedPtr<FAr...


className: TDecay

code: template<typename T> struct TDecay


code: TScopedDurationThreadSafeTimer ( ThreadSafeCounterClass & InCounter )


className: TScopedDurationThreadSafeTimer

description: ThreadSafeCounterClass is expected to be a thread-safe type with a non-static member Add(uint32) that will work correctly if called from multiple threads simultaneously.

code: template<typename ThreadSafeCounterClass> class TScopedDurationThreadSafeTimer


code: template<typename T> auto Requires ( const T & )


className: CProvidesDefaultUObject

description: Access to a global default object is required in order to patch vtables Normally this can be provided by a default-constructed object. For objects without default constructors, a default object must be provided through the global function GetDefault()THasCustomDefaultObject::Value must be specialized to true for these types. This is done by default for any UObject-derived types, which already provide GetDefault()

code: struct CProvidesDefaultUObject


className: EParseResult

description: Internal enum to control parsing progress

code: enum EParseResult { EndOfCell, EndOfRow, EndOfString, }


className: FRows

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< [TArray](API\Runtime\Core\Containers\TArray)< const TCHAR * > > FRows


description: Const access to the parsed rows Rows are stored as arrays of parsed, null-terminated cell-strings. Object (and contained strings) is valid for the lifetime of the parser.

code: const [FRows](API\Runtime\Core\Serialization\Csv\FCsvParser\FRows) & GetRows() const


code: [FCsvParser](API\Runtime\Core\Serialization\Csv\FCsvParser) & operator= ( [FCsvParser](API\Runtime\Core\Serialization\Csv\FCsvParser) && )


code: [FCsvParser](API\Runtime\Core\Serialization\Csv\FCsvParser) & operator= ( const [FCsvParser](API\Runtime\Core\Serialization\Csv\FCsvParser) & )


description: Construct with a string. Takes a copy because the parser tramples over the file to create null-terminated cell strings Avoid a copy by passing overship of the source string with MoveTemp()

code: FCsvParser ( [FString](API\Runtime\Core\Containers\FString) && InSourceString )


description: Non copyable - has pointers to itself

code: FCsvParser ( [FCsvParser](API\Runtime\Core\Serialization\Csv\FCsvParser) && )


code: FCsvParser ( const [FString](API\Runtime\Core\Containers\FString) & InSourceString )


code: FCsvParser ( const [FCsvParser](API\Runtime\Core\Serialization\Csv\FCsvParser) & )


className: FCsvParser

description: A simple, efficient csv parser

code: struct FCsvParser


className: Type

code: enum Type { Unknown, Guids, Enums, Optimized, CustomVersion_Automatic_Plus_One, Latest = CustomVersion_Automatic_Plus_One - 1, }


code: namespace EFieldLayoutFlags { [Type](API\Runtime\Core\Serialization\EFieldLayoutFlags__Type) EFieldLayoutFlags::MakeFlags ( uint32 Flags ) }


code: namespace EFieldLayoutFlags { [Type](API\Runtime\Core\Serialization\EFieldLayoutFlags__Type) EFieldLayoutFlags::MakeFlagsEditorOnly ( uint32 Flags ) }


code: namespace EFieldLayoutFlags { [Type](API\Runtime\Core\Serialization\EFieldLayoutFlags__Type) EFieldLayoutFlags::MakeFlagsRayTracing ( uint32 Flags ) }


code: namespace EFieldLayoutFlags { enum Type { None = 0u, WithEditorOnly = (1u << 0), WithRayTracing = (1u << 1), Transient = (1u << 2), UseInstanceWithNoProperty = (1u << 3), } }


code: namespace ETypeLayoutInterface { bool ETypeLayoutInterface::HasVTable ( [Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InType ) }


code: namespace ETypeLayoutInterface { enum Type { NonVirtual, Virtual, Abstract, } }


code: virtual void AttachBulkData ( [UE::Serialization::FEditorBulkData](API\Runtime\CoreUObject\Serialization\FEditorBulkData) * BulkData )


description: Attaches/ associates the passed in bulk data object with the linker.

code: virtual void AttachBulkData ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Owner, [FBulkData](API\Runtime\CoreUObject\Serialization\FBulkData) * BulkData )


description:
Adds external read dependency
true if dependency has been added, false if Archive does not support them

code: virtual bool AttachExternalReadDependency ( FExternalReadCallback & ReadCallback )


description: Used internally only to control the amount of generated code/type under control.

code: template<typename T> FArchive & ByteOrderSerialize &40; T & Value &41;


description: Serialize data of Length bytes, taking into account byte swapping if needed.

code: [FArchive](API\Runtime\Core\Serialization\FArchive) & ByteOrderSerialize ( void * V, int32 Length )


description: Used to do byte swapping on small items. This does not happen usually, so we don't want it inline.

code: void ByteSwap ( void * V, int32 Length )


description: Attempts to close and finalize any handles used for backing data storage, returns true if it succeeded.

code: virtual bool Close()


description: Detaches the passed in bulk data object from the linker.

code: virtual void DetachBulkData ( [FBulkData](API\Runtime\CoreUObject\Serialization\FBulkData) * BulkData, bool bEnsureBulkDataIsLoaded )


code: virtual void DetachBulkData ( [UE::Serialization::FEditorBulkData](API\Runtime\CoreUObject\Serialization\FEditorBulkData) * BulkData, bool bEnsureBulkDataIsLoaded )


code: template<SIZE_T Size> bool FastPathLoad ( void * InDest )


description: Attempts to finish writing any buffered data to disk/permanent storage.

code: virtual void Flush()


description: Flushes cache and frees internal data.

code: virtual void FlushCache()


description: Inform the archive that a blueprint would like to force finalization, normally this is triggered by CDO load, but if there's no CDO we force finalization.


code: FScopeAddDebugData &40; FArchive & InAr, const FName & DebugData &41;


className: FScopeAddDebugData

code: class FScopeAddDebugData


code: FScopeSeekTo & operator&61; &40; const FScopeSeekTo & &41;


code: FScopeSeekTo &40; const FScopeSeekTo & &41;


code: FScopeSeekTo &40; FArchive & InAr, int64 InPos &41;


className: FScopeSeekTo

description: Seeks to and restores the position of an archive.

code: class FScopeSeekTo


description: Initializes an object which will set flags for the scope of this code

code: FScopeSetDebugSerializationFlags &40; FArchive & InAr, uint32 NewFlags, bool Remove &41;


className: FScopeSetDebugSerializationFlags

code: class FScopeSetDebugSerializationFlags


description: Returns the low level archive state for this archive.


code: const [FArchiveState](API\Runtime\Core\Serialization\FArchiveState) & GetArchiveState() const


description: Returns a pointer to an archive that represents the same data that the current archive covers, but that can be cached and reused later In the case of standard archives, this function will just return a pointer to itself. If the archive is actually a temporary proxy to another archive, and has a shorter lifecycle than the source archive, it should return either a pointer to the underlying archive, or if the data becomes inaccessible when the proxy object disappears (as is the case with text format archives) then nullptr

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) * GetCacheableArchive()


description: Determine if the given archive is a valid "child" of this archive. In general, this means "is exactly the same" but this function allows a derived archive to support "child" or "internal" archives which are different objects that proxy the original one in some way.

code: virtual bool IsProxyOf ( [FArchive](API\Runtime\Core\Serialization\FArchive) * InOther ) const


description: Logf implementation for convenience.

code: template<typename FmtType, typename... Types> void Logf ( const FmtType & Fmt, Types... Args )


description: Called when an object stops serializing property data using script serialization.

code: virtual void MarkScriptSerializationEnd ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * Obj )


description: Called when an object begins serializing property data using script serialization.

code: virtual void MarkScriptSerializationStart ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * Obj )


description: Called to register a reference to a specific name value, of type TypeObject (UEnumorUStructnormally). Const so it can be called from PostSerialize

code: virtual void MarkSearchableName ( const [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< const [UObject](API\Runtime\CoreUObject\UObject\UObject) > & TypeObject, const [FName](API\Runtime\Core\UObject\FName) & ValueName ) const


code: [FArchive](API\Runtime\Core\Serialization\FArchive) & operator= ( const [FArchive](API\Runtime\Core\Serialization\FArchive) & ArchiveToCopy )


description:
This operator can be implemented by sub-classes that wish to serializeFNameinstances.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FName](API\Runtime\Core\UObject\FName) & Value )


description:
This operator can be implemented by sub-classes that wish to serializeFWeakObjectPtrinstances.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( struct [FWeakObjectPtr](API\Runtime\CoreUObject\UObject\FWeakObjectPtr) & Value )


description: Serializes anFTextvalue from or into an archive.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FText](API\Runtime\Core\Internationalization\FText) & Value )


description:
This operator can be implemented by sub-classes that wish to serializeUObjectinstances.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FField](API\Runtime\CoreUObject\UObject\FField) *& Value )


description:
Serializes aUObjectwrapped in aTCheckedObjPtrcontainer, using the above operator, and verifies the serialized object is derived from the correct base class, to prevent illegal casting.
This instance.

code: template<class T> [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [TCheckedObjPtr](API\Runtime\Core\Serialization\TCheckedObjPtr)< T > & Value )


description:
Most of the time, FLazyObjectPtrs are serialized as UObject*, but some archives need to override this.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( struct [FLazyObjectPtr](API\Runtime\CoreUObject\UObject\FLazyObjectPtr) & Value )


description:
Most of the time, FObjectPtrs are serialized as UObject*, but some archives need to override this.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( struct [FObjectPtr](API\Runtime\CoreUObject\UObject\FObjectPtr) & Value )


description:
Most of the time,FSoftObjectPtrare serialized asUObject*, but some archives need to override this.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( struct [FSoftObjectPtr](API\Runtime\CoreUObject\UObject\FSoftObjectPtr) & Value )


description:
Serializes soft object paths from or into this archive.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( struct [FSoftObjectPath](API\Runtime\CoreUObject\UObject\FSoftObjectPath) & Value )


description: Pop a property that was previously being serialized off the property stack

code: virtual void PopSerializedProperty ( class [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty, const bool bIsEditorOnlyProperty )


description:
This function will not change the current archive position.
false if precache operation is still pending, true otherwise

code: virtual bool Precache ( int64 PrecacheOffset, int64 PrecacheSize )


code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [UObject](API\Runtime\CoreUObject\UObject\UObject) *& Value )


description: Tells the archive to attempt to preload the specified object so data can be loaded out of it.

code: virtual void Preload ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )


description: Debug stack storage if you want to add data to the archive for usage further down the serialization stack this should be used in conjunction with theFScopeAddDebugDatastruct

code: virtual void PushDebugDataString ( const [FName](API\Runtime\Core\UObject\FName) & DebugData )


description: Called whilst cooking to provide file region hints to the cooker.

code: virtual void PushFileRegionType ( EFileRegionType Type )


description: Push a property that is currently being serialized onto the property stack

code: virtual void PushSerializedProperty ( class [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty, const bool bIsEditorOnlyProperty )


code: virtual void Serialize ( void * V, int64 Length )


description: Attempts to set the current offset into backing data storage, this will do nothing if there is no storage.

code: virtual void Seek ( int64 InPos )


code: virtual void SerializeBits ( void * V, int64 LengthBits )


description: Serializes a Boolean value from or into an archive.

code: virtual void SerializeBool ( bool & D )


description:
Serialize bulk data.
true if the bulk data was serialized, false to fallback to default serialization (inline)

code: virtual bool SerializeBulkData ( [FBulkData](API\Runtime\CoreUObject\Serialization\FBulkData) & BulkData, const struct [FBulkDataSerializationParams](API\Runtime\CoreUObject\Serialization\FBulkDataSerializationParams) & Params )


description: Do not use SerializeCompressed in new code, prefer SerializeCompressedNew instead. SerializeCompressedNew can be dropped in to any existing use of SerializeCompressed.

code: void SerializeCompressed ( void * V, int64 Length, [FName](API\Runtime\Core\UObject\FName) CompressionFormatCannotChange, ECompressionFlags Flags, bool bTreatBufferAsFileReader )


description: Default compressors are Oodle for new data and Zlib when loading legacy data.

code: void SerializeCompressedNew ( void * V, int64 Length )


description: SerializeCompressedNew can read existing data written by old SerializeCompressed calls.

code: void SerializeCompressedNew ( void * V, int64 Length, [FName](API\Runtime\Core\UObject\FName) CompressionFormatToEncode, [FName](API\Runtime\Core\UObject\FName) CompressionFormatToDecodeOldV1Files, ECompressionFlags Flags, bool bTreatBufferAsFileReader, int64 * OutPartialReadLength )


code: virtual void SerializeInt ( uint32 & Value, uint32 Max )


description: Packs int value into bytes of 7 bits with 8th bit for 'more'

code: virtual void SerializeIntPacked ( uint32 & Value )


code: virtual void SerializeIntPacked64 ( uint64 & Value )


description:
Sets mapping from offsets/ sizes that are going to be used for seeking and serialization to what is actually stored on disk. If the archive supports dealing with compression in this way it is going to return true.
true if archive supports translating offsets & uncompressing on read, false otherwise

code: virtual bool SetCompressionMap ( [TArray](API\Runtime\Core\Containers\TArray)< struct [FCompressedChunk](API\Runtime\CoreUObject\UObject\FCompressedChunk) > * CompressedChunks, ECompressionFlags CompressionFlags )


description: Sets a flag indicating that this archive is currently serializing class/struct defaults.

code: void StartSerializingDefaults()


description: Indicate that this archive is no longer serializing class/struct defaults.

code: void StopSerializingDefaults()


description: Registers the custom version to the archive. This is used to inform the archive that custom version information is about to be stored. There is no effect when the archive is being loaded from.

code: virtual void UsingCustomVersion ( const struct [FGuid](API\Runtime\Core\Misc\FGuid) & Guid )


code: FArchive ( const [FArchive](API\Runtime\Core\Serialization\FArchive) & )


code: FArchiveCookData ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) & InTargetPlatform, [FArchiveCookContext](API\Runtime\CoreUObject\UObject\FArchiveCookContext) & InCookContext )


className: FArchive

description: Base class for archives that can be used for loading, saving, and garbage collecting in a byte order neutral way.

code: class FArchive : private [FArchiveState](API\Runtime\Core\Serialization\FArchiveState)


className: FArchiveCookData

description: Holds archive data only relevant for cooking archives. Fill this out as part ofFSavePackageArgs.

code: struct FArchiveCookData

CookContext

type: FArchiveCookCon...

TargetPlatform

type: constITargetPl...


code: FArchiveFieldName ( const TCHAR * InName )


className: FArchiveFieldName

description: Define a structure to encapsulate a field name, which compiles to an empty object if WITH_TEXT_ARCHIVE_SUPPORT = 0.

code: struct FArchiveFieldName

Name

type: const TCHAR ...


code: const [FArchive](API\Runtime\Core\Serialization\FArchive) & GetArchive() const


code: FArchiveFromStructuredArchive ( [FStructuredArchiveSlot](API\Runtime\Core\Serialization\FStructuredArchiveSlot) InSlot )


className: FArchiveFromStructuredArchive

code: class FArchiveFromStructuredArchive


description: Returns true if the current location within the backing data storage is at the end, always returns false if there is no storage.

code: virtual bool AtEnd()


description: Attempts to close and finalize any handles used for backing data storage, returns true if it succeeded.

code: virtual bool Close()


className: MaxBufferSize

code: static MaxBufferSize = 128;


code: FImpl &40; FStructuredArchive::FSlot Slot &41;


code: virtual bool Finalize ( [FStructuredArchiveRecord](API\Runtime\Core\Serialization\FStructuredArchiveRecord) Record )


description: Attempts to finish writing any buffered data to disk/permanent storage.

code: virtual void Flush()


description: Returns a pointer to an archive that represents the same data that the current archive covers, but that can be cached and reused later In the case of standard archives, this function will just return a pointer to itself. If the archive is actually a temporary proxy to another archive, and has a shorter lifecycle than the source archive, it should return either a pointer to the underlying archive, or if the data becomes inaccessible when the proxy object disappears (as is the case with text format archives) then nullptr

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) * GetCacheableArchive()


description:
This operator can be implemented by sub-classes that wish to serializeFNameinstances.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( class [FName](API\Runtime\Core\UObject\FName) & Value )


description:
This operator can be implemented by sub-classes that wish to serializeUObjectinstances.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( class [UObject](API\Runtime\CoreUObject\UObject\UObject) *& Value )


description: Serializes anFTextvalue from or into an archive.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( class [FText](API\Runtime\Core\Internationalization\FText) & Value )


className: FImpl

code: struct FImpl

bPendingSerialize

type: bool

Buffer

type: TArray< uint8 >

Names

type: TArray<FName>

NameToIndex

type: TMap<FName, in...

ObjectNames

type: TArray<FString...

Objects

type: TArray<UObject...

ObjectsValid

type: TBitArray

ObjectToIndex

type: TMap<UObject&...

Root

type: TOptional<FStr...

RootSlot

type: FStructuredArch...


description: Attempts to set the current offset into backing data storage, this will do nothing if there is no storage.

code: virtual void Seek ( int64 InPos )


code: virtual void Serialize ( void * V, int64 Length )


description: Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location. If this returns -1, there is no backing data storage and Seek will not function.

code: virtual int64 Tell()


description: Returns total size of the backing data storage.

code: virtual int64 TotalSize()


code: FArchiveFromStructuredArchiveImpl &40; FArchiveFromStructuredArchiveImpl && &41;


code: FArchiveFromStructuredArchiveImpl &40; const FArchiveFromStructuredArchiveImpl & &41;


code: FArchiveFromStructuredArchiveImpl ( [FStructuredArchiveSlot](API\Runtime\Core\Serialization\FStructuredArchiveSlot) Slot )


className: FArchiveFromStructuredArchiveImpl

code: class FArchiveFromStructuredArchiveImpl : public [FArchiveProxy](API\Runtime\Core\Serialization\FArchiveProxy)


description: Seeks to the passed in position in the stream. This archive only supports forward seeking and implements it by serializing data till it reaches the position.


description: Serializes data from archive. This function is called recursively and determines where to serialize from and how to do so based on internal state.

code: virtual void Serialize ( void * Data, int64 Count )


description:
Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location. If this returns -1, there is no backing data storage and Seek will not function.
current position in uncompressed stream in bytes.


code: FArchiveLoadCompressedProxy ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InCompressedData, [FName](API\Runtime\Core\UObject\FName) CompressionFormat, ECompressionFlags InCompressionFlags )


description: Destructor, freeing temporary memory.

code: virtual ~FArchiveLoadCompressedProxy()


className: FArchiveLoadCompressedProxy

description: FArchiveProxy to transparently load compressed data from an array.

code: class FArchiveLoadCompressedProxy : public [FArchive](API\Runtime\Core\Serialization\FArchive)


code: virtual bool AtEnd()


description: Attaches/ associates the passed in bulk data object with the linker.

code: virtual void AttachBulkData ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Owner, [FBulkData](API\Runtime\CoreUObject\Serialization\FBulkData) * BulkData )


description:
Adds external read dependency
true if dependency has been added, false if Archive does not support them

code: virtual bool AttachExternalReadDependency ( FExternalReadCallback & ReadCallback )


code: virtual bool Close()


description: Called to get the computed size from a size-detecting archive after it has finished serializing.

code: virtual void CountBytes ( SIZE_T InNum, SIZE_T InMax )


description: Detaches the passed in bulk data object from the linker.

code: virtual void DetachBulkData ( [FBulkData](API\Runtime\CoreUObject\Serialization\FBulkData) * BulkData, bool bEnsureBulkDataIsLoaded )


code: virtual void Flush()


description: Flushes cache and frees internal data.

code: virtual void FlushCache()


description: Inform the archive that a blueprint would like to force finalization, normally this is triggered by CDO load, but if there's no CDO we force finalization.


description: Called to retrieve the archetype from the event driven loader. If this returns null, then call GetArchetype yourself.

code: virtual [UObject](API\Runtime\CoreUObject\UObject\UObject) * GetArchetypeFromLoader ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * Obj )


description: This is overridden for the specific Archive Types

code: virtual [FString](API\Runtime\Core\Containers\FString) GetArchiveName() const


description:
Gets the custom version numbers for this archive. These are used to check for system or game-specific version numbers.
The container of custom versions in the archive.

code: virtual const [FCustomVersionContainer](API\Runtime\Core\Serialization\FCustomVersionContainer) & GetCustomVersions() const


description: Returns a pointer to an archive that represents the same data that the current archive covers, but that can be cached and reused later In the case of standard archives, this function will just return a pointer to itself. If the archive is actually a temporary proxy to another archive, and has a shorter lifecycle than the source archive, it should return either a pointer to the underlying archive, or if the data becomes inaccessible when the proxy object disappears (as is the case with text format archives) then nullptr

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) * GetCacheableArchive()


description: Returns lowest level archive state, proxy archives will override this.

code: virtual ::[FArchiveState](API\Runtime\Core\Serialization\FArchiveState) & GetInnermostState()


description:
If this archive is aFLinkerLoadorFLinkerSave, returns a pointer to the ULinker portion.
The linker, or nullptr if the archive is not a linker.

code: virtual [FLinker](API\Runtime\CoreUObject\UObject\FLinker) * GetLinker()


description: Returns true if the stack of currently serialized properties contains an editor-only property

code: virtual bool IsEditorOnlyPropertyOnTheStack() const


description: Determine if the given archive is a valid "child" of this archive. In general, this means "is exactly the same" but this function allows a derived archive to support "child" or "internal" archives which are different objects that proxy the original one in some way.

code: virtual bool IsProxyOf ( [FArchive](API\Runtime\Core\Serialization\FArchive) * InOther ) const


description: Called when an object stops serializing property data using script serialization.

code: virtual void MarkScriptSerializationEnd ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * Obj )


description: Called when an object begins serializing property data using script serialization.

code: virtual void MarkScriptSerializationStart ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * Obj )


description: Called to register a reference to a specific name value, of type TypeObject (UEnumorUStructnormally). Const so it can be called from PostSerialize

code: virtual void MarkSearchableName ( const [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< const [UObject](API\Runtime\CoreUObject\UObject\UObject) > & TypeObject, const [FName](API\Runtime\Core\UObject\FName) & ValueName ) const


code: [FArchiveProxy](API\Runtime\Core\Serialization\FArchiveProxy) & operator= ( [FArchiveProxy](API\Runtime\Core\Serialization\FArchiveProxy) && )


code: [FArchiveProxy](API\Runtime\Core\Serialization\FArchiveProxy) & operator= ( const [FArchiveProxy](API\Runtime\Core\Serialization\FArchiveProxy) & )


description:
This operator can be implemented by sub-classes that wish to serializeFNameinstances.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FName](API\Runtime\Core\UObject\FName) & Value )


description: Serializes anFTextvalue from or into an archive.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FText](API\Runtime\Core\Internationalization\FText) & Value )


description:
This operator can be implemented by sub-classes that wish to serializeUObjectinstances.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [UObject](API\Runtime\CoreUObject\UObject\UObject) *& Value )


description: Get the localization namespace that this archive should use when serializing text properties. This is typically the namespace used by the package being serialized (if serializing a package, or an object within a package).

code: virtual [FString](API\Runtime\Core\Containers\FString) GetLocalizationNamespace() const


description:
Most of the time, FObjectPtrs are serialized as UObject*, but some archives need to override this.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FObjectPtr](API\Runtime\CoreUObject\UObject\FObjectPtr) & Value )


description:
Most of the time, FLazyObjectPtrs are serialized as UObject*, but some archives need to override this.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FLazyObjectPtr](API\Runtime\CoreUObject\UObject\FLazyObjectPtr) & Value )


description:
Serializes soft object paths from or into this archive.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FSoftObjectPath](API\Runtime\CoreUObject\UObject\FSoftObjectPath) & Value )


description:
Most of the time,FSoftObjectPtrare serialized asUObject*, but some archives need to override this.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FSoftObjectPtr](API\Runtime\CoreUObject\UObject\FSoftObjectPtr) & Value )


description:
This operator can be implemented by sub-classes that wish to serializeFWeakObjectPtrinstances.
This instance.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FWeakObjectPtr](API\Runtime\CoreUObject\UObject\FWeakObjectPtr) & Value )


code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FField](API\Runtime\CoreUObject\UObject\FField) *& Value )


description: Pops editor-only marker from the stack of currently serialized properties

code: virtual void PopSerializedProperty ( class [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty, const bool bIsEditorOnlyProperty )


description:
This function will not change the current archive position.
false if precache operation is still pending, true otherwise

code: virtual bool Precache ( int64 PrecacheOffset, int64 PrecacheSize )


description: Tells the archive to attempt to preload the specified object so data can be loaded out of it.

code: virtual void Preload ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )


description: Debug stack storage if you want to add data to the archive for usage further down the serialization stack this should be used in conjunction with the FScopeAddDebugData struct

code: virtual void PushDebugDataString ( const [FName](API\Runtime\Core\UObject\FName) & DebugData )


description: Pushes editor-only marker to the stack of currently serialized properties

code: virtual void PushSerializedProperty ( class [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty, const bool bIsEditorOnlyProperty )


description: Resets the custom version numbers for this archive.

code: virtual void ResetCustomVersions()


description: Attempts to set the current offset into backing data storage, this will do nothing if there is no storage.

code: virtual void Seek ( int64 InPos )


code: virtual void Serialize ( void * V, int64 Length )


code: virtual void SerializeBits ( void * Bits, int64 LengthBits )


description:
Serialize bulk data.
true if the bulk data was serialized, false to fallback to default serialization (inline)

code: virtual bool SerializeBulkData ( class [FBulkData](API\Runtime\CoreUObject\Serialization\FBulkData) & BulkData, const struct [FBulkDataSerializationParams](API\Runtime\CoreUObject\Serialization\FBulkDataSerializationParams) & Params )


code: virtual void SerializeInt ( uint32 & Value, uint32 Max )


description: Packs int value into bytes of 7 bits with 8th bit for 'more'

code: virtual void SerializeIntPacked ( uint32 & Value )


description:
Sets mapping from offsets/ sizes that are going to be used for seeking and serialization to what is actually stored on disk. If the archive supports dealing with compression in this way it is going to return true.
true if archive supports translating offsets & uncompressing on read, false otherwise

code: virtual bool SetCompressionMap ( [TArray](API\Runtime\Core\Containers\TArray)< [FCompressedChunk](API\Runtime\CoreUObject\UObject\FCompressedChunk) > * CompressedChunks, ECompressionFlags CompressionFlags )


description: Sets the custom version numbers for this archive.

code: virtual void SetCustomVersions ( const [FCustomVersionContainer](API\Runtime\Core\Serialization\FCustomVersionContainer) & CustomVersionContainer )


description: Sets a flag indicating that this archive needs to filter editor-only content.

code: virtual void SetFilterEditorOnly ( bool InFilterEditorOnly )


description: Set the localization namespace that this archive should use when serializing text properties. This is typically the namespace used by the package being serialized (if serializing a package, or an object within a package).

code: virtual void SetLocalizationNamespace ( const [FString](API\Runtime\Core\Containers\FString) & InLocalizationNamespace )


description: Checks whether the archive wants to skip the property independent of the other flags

code: virtual bool ShouldSkipProperty ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty ) const


description: You likely want to call PushSerializedProperty/PopSerializedProperty instead

code: virtual void SetSerializedProperty ( [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty )


description: Set the raw serialized property chain for this archive, optionally overriding the serialized property too (or null to use the head of the property chain)

code: virtual void SetSerializedPropertyChain ( const [FArchiveSerializedPropertyChain](API\Runtime\Core\Serialization\FArchiveSerializedPropertyChain) * InSerializedPropertyChain, class [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InSerializedPropertyOverride )


description: Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location. If this returns -1, there is no backing data storage and Seek will not function.

code: virtual int64 Tell()


description: Returns total size of the backing data storage.

code: virtual int64 TotalSize()


description:
Checks whether the archive is used to resolve out-of-date enum indexes If function returns true, the archive should be called only for objects containing user defined enum
true if the archive is used to resolve out-of-date enum indexes

code: virtual bool UseToResolveEnumerators() const


description: Creates and initializes a new instance of the archive proxy.

code: FArchiveProxy ( [FArchive](API\Runtime\Core\Serialization\FArchive) & InInnerArchive )


description: Non-copyable.

code: FArchiveProxy ( [FArchiveProxy](API\Runtime\Core\Serialization\FArchiveProxy) && )


className: FArchiveProxy

description: Archive proxies are archive types that modify the behavior of another archive type.

code: class FArchiveProxy : public [FArchive](API\Runtime\Core\Serialization\FArchive)

InnerArchive

type: FArchive&

description: Holds the archive that this archive is a proxy to.


description: This enum and the following constructor is a workaround for VC compiler bug that prevents using attributes on constructors without inline implementation. This should be removed when the deprecated ctor is removed.

code: enum EVS2015Redirector { Redirect, }


code: FArchiveProxy ( const [FArchiveProxy](API\Runtime\Core\Serialization\FArchiveProxy) & )


description: Flushes tmp data to array.

code: virtual void Flush()


description: Seeking is only implemented internally for writing out compressed data and asserts otherwise.

code: virtual void Seek ( int64 InPos )


description: Serializes data to archive. This function is called recursively and determines where to serialize to and how to do so based on internal state.

code: virtual void Serialize ( void * Data, int64 Count )


description:
Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location. If this returns -1, there is no backing data storage and Seek will not function.
current position in uncompressed stream in bytes


description: Constructor, initializing all member variables and allocating temp memory.

code: FArchiveSaveCompressedProxy ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InCompressedData, ECompressionFlags InCompressionFlags )


code: FArchiveSaveCompressedProxy ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InCompressedData, [FName](API\Runtime\Core\UObject\FName) InCompressionFormat, ECompressionFlags InCompressionFlags )


code: FArchiveSaveCompressedProxy &40; EVS2015Redirector, TArray< uint8 > & InCompressedData, ECompressionFlags InCompressionFlags &41;


description: Destructor, flushing array if needed. Also frees temporary memory.

code: virtual ~FArchiveSaveCompressedProxy()


description: This index is in array order, so the 0th index with be the root property on the stack

code: [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * GetPropertyFromRoot ( const int32 InRootIndex ) const


className: FArchiveSaveCompressedProxy

description: FArchiveProxy to transparently write out compressed data to an array.

code: class FArchiveSaveCompressedProxy : public [FArchive](API\Runtime\Core\Serialization\FArchive)


description: Get the number of properties currently on the stack

code: int32 GetNumProperties() const


description: This index is in stack order, so the 0th index with be the leaf property on the stack

code: [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * GetPropertyFromStack ( const int32 InStackIndex ) const


description: Get the counter for the number of times that SerializedPropertyChain has been updated

code: uint32 GetUpdateCount() const


description: Check to see whether there are any editor-only properties on the stack

code: bool HasEditorOnlyProperty() const


description: Pop a property that was previously being serialized

code: void PopProperty ( class [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty, const bool bIsEditorOnlyProperty )


description: Push a property that is currently being serialized

code: void PushProperty ( class [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty, const bool bIsEditorOnlyProperty )


description: Default constructor

code: FArchiveSerializedPropertyChain()


description: Returns true if the current location within the backing data storage is at the end, always returns false if there is no storage.

code: virtual bool AtEnd()


description: Returns true if this archive contains native or generated code.

code: bool ContainsCode() const


description: Sets ArIsError to false, this does not clear any CriticalErrors

code: void ClearError()


description:
Returns the cooking target platform.
Target platform.

code: const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * CookingTarget() const


description: Copies all of the members except CustomVersionContainer

code: void CopyTrivialFArchiveStatusMembers ( const [FArchiveState](API\Runtime\Core\Serialization\FArchiveState) & ArchiveStatusToCopy )


description:
Queries a custom version from the archive. If the archive is being used to write, the custom version must have already been registered.
The version number, or -1 if the custom tag isn't stored in the archive.

code: int32 CustomVer ( const struct [FGuid](API\Runtime\Core\Misc\FGuid) & Key ) const


description: Called to get the computed size from a size-detecting archive after it has finished serializing.

code: virtual void CountBytes ( SIZE_T InNum, SIZE_T InMax )


description: Returns true if this archive should perform delta serialization within properties (e.g. TMaps and TSets).

code: bool DoIntraPropertyDelta() const


description: Returns true if this archive should handle delta serialization for properties.

code: bool DoDelta() const


className: FArchiveSerializedPropertyChain

description: Structure containing the stack of properties that are currently being serialized by an archive

code: struct FArchiveSerializedPropertyChain


description: Returns the engine-global network protocol version for this archive.

code: virtual uint32 EngineNetVer() const


description: Returns true if this archive contains aULevelorUWorldobject.

code: bool ContainsMap() const


description: Returns the compiled engine version used for this archive.


description: Returns true if this archive should always swap bytes, ignoring endian rules.

code: bool ForceByteSwapping() const


description: Returns the game-specific network protocol version for this archive.

code: virtual uint32 GameNetVer() const


className: FFastPathLoadBuffer

description: These are used for fastpath inline serializers

code: struct FFastPathLoadBuffer

EndFastPathLoadBuffer

type: const uint8 ...


description: Called to retrieve the archetype from the event driven loader. If this returns null, then call GetArchetype yourself.

code: virtual [UObject](API\Runtime\CoreUObject\UObject\UObject) * GetArchetypeFromLoader ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * Obj )


description: This is overridden for the specific Archive Types

code: virtual [FString](API\Runtime\Core\Containers\FString) GetArchiveName() const


description: See GetLocalizationNamespace


description: Returns the editor-only debug serialization flags.


description: Returns lowest level archive state, proxy archives will override this.

code: virtual [FArchiveState](API\Runtime\Core\Serialization\FArchiveState) & GetInnermostState()


description:
If this archive is aFLinkerLoadorFLinkerSave, returns a pointer to the ULinker portion.
The linker, or nullptr if the archive is not a linker.

code: virtual [FLinker](API\Runtime\CoreUObject\UObject\FLinker) * GetLinker()


description: Get the localization namespace that this archive should use when serializing text properties. This is typically the namespace used by the package being serialized (if serializing a package, or an object within a package).

code: virtual [FString](API\Runtime\Core\Containers\FString) GetLocalizationNamespace() const


description: Gets the currentUObjectserialization context for this archive.

code: virtual [FUObjectSerializeContext](API\Runtime\CoreUObject\UObject\FUObjectSerializeContext) * GetSerializeContext()


description: Returns this archive's property serialization modifier flags.

code: uint32 GetPortFlags() const


description: Returns the maximum size of data that this archive is allowed to serialize.

code: int64 GetMaxSerializeSize() const


description:
Gets the property that is currently being serialized
Pointer to the property that is currently being serialized

code: [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * GetSerializedProperty() const


description:
Gets the custom version numbers for this archive. These are used to check for system or game-specific version numbers.
The container of custom versions in the archive.

code: virtual const [FCustomVersionContainer](API\Runtime\Core\Serialization\FCustomVersionContainer) & GetCustomVersions() const


description: Accessing this directly can avoid an array allocation depending on your use-case

code: const [FArchiveSerializedPropertyChain](API\Runtime\Core\Serialization\FArchiveSerializedPropertyChain) * GetSerializedPropertyChain() const


description: This populates the array in stack order, so the 0th entry in the array is the top of the stack of properties

code: void GetSerializedPropertyChain ( [TArray](API\Runtime\Core\Containers\TArray)< class [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * > & OutProperties ) const


description: Checks to see if all of the passed in property serialization modifier flags are set.

code: bool HasAllPortFlags ( uint32 Flags ) const


description: Checks to see if any of the passed in property serialization modifier flags are set.

code: bool HasAnyPortFlags ( uint32 Flags ) const


description: Returns true if this archive sould allow lazy loading of bulk / secondary data.

code: bool IsAllowingLazyLoading() const


description: Returns true if data larger than 1 byte should be swapped to deal with endian mismatches.

code: bool IsByteSwapping()


description:
Checks whether the archive is used for cooking.
true if the archive is used for cooking, false otherwise.

code: bool IsCooking() const


description: Returns true if this archive is counting memory, normally CountBytes is called to get the size.

code: bool IsCountingMemory() const


description: Returns true if this archive contains critical errors that cannot be recovered from.

code: bool IsCriticalError() const


description: Returns true if the stack of currently serialized properties contains an editor-only property

code: virtual bool IsEditorOnlyPropertyOnTheStack() const


description: Returns true if this archive contains errors, which means that further serialization is generally not safe.

code: bool IsError() const


description:
Indicates whether this archive is filtering editor-only on save or contains data that had editor-only content stripped.
true if the archive filters editor-only content, false otherwise.

code: bool IsFilterEditorOnly() const


description: Returns true if this archive wants to always save strings in UTF16 format even if they are ANSI characters.

code: bool IsForcingUnicode() const


description: Returns true if this archive should ignore archetype references for structs and classes.

code: bool IsIgnoringArchetypeRef() const


description: Returns true if this archive should ignore the Class reference inUObject.

code: bool IsIgnoringClassRef() const


description: Returns true if this archive should ignore the ClassGeneratedBy reference inUClass.


description: Returns true if this archive should ignore the Outer reference inUObject.

code: bool IsIgnoringOuterRef() const


description: Returns true if this archive is for loading data.

code: bool IsLoading() const


description: Returns true if this archive is loading from a cooked package.

code: bool IsLoadingFromCookedPackage() const


description: Whether or not this archive is serializing data being sent/received by the netcode

code: bool IsNetArchive() const


description: Returns true if this archive should modify/search weak object references as well as strong ones.


description: Returns true if this archive is only looking forUObjectreferences. This can be false for reference collectors looking for more general references.

code: bool IsObjectReferenceCollector() const


description: Returns true if this archive is saving or loading data destined for persistent storage and should skip transient data. This is also true for some intermediate archives for tasks like duplication that are eventually destined for persistent storage.

code: bool IsPersistent() const


description: Returns true if this archive is currently serializing class/struct default values.

code: bool IsSerializingDefaults() const


description: Returns true if this archive is for saving data, this can also be a pre-save preparation archive.

code: bool IsSaving() const


description: Returns true if this archive serializes to a structured text format. Text format archives should use high level constructs fromFStructuredArchivefor delimiting data rather than manually seeking through the file.

code: bool IsTextFormat() const


description:
This is intended for game-specific archives and is not true for any of the build in save methods
true if the archive is dealing with save games, false otherwise.

code: bool IsSaveGame() const


description: Returns true if this archive is transacting, which is used to keep track of changes to objects for things like the editor undo system.

code: bool IsTransacting() const


description: Returns the licensee-specific version used for this archive, will be 0 by default.

code: int32 LicenseeUE4Ver() const


code: int32 LicenseeUEVer() const


code: static void LinkProxy ( [FArchiveState](API\Runtime\Core\Serialization\FArchiveState) & Inner, [FArchiveState](API\Runtime\Core\Serialization\FArchiveState) & Proxy )


description: Resets all of the base archive members.

code: virtual void Reset()


description: Returns true if this archive contains data required to be gathered for localization.

code: bool RequiresLocalizationGather() const


description: Resets the custom version numbers for this archive.

code: virtual void ResetCustomVersions()


description: Modifies current archive state, can be used to override flags.

code: void SetArchiveState ( const [FArchiveState](API\Runtime\Core\Serialization\FArchiveState) & InState )


description: Toggle byte order swapping. This is needed in rare cases when we already know that the data swapping has already occurred or if we know that it will be handled later.

code: void SetByteSwapping ( bool Enabled )


description: See SetLocalizationNamespace

code: void SetBaseLocalizationNamespace ( const [FString](API\Runtime\Core\Containers\FString) & InLocalizationNamespace )


description: Marks that this archive is "cooking" by providing the cook data bundle. Must be set after loading/saving/transacting.

code: void SetCookData ( [FArchiveCookData](API\Runtime\Core\Serialization\FArchiveCookData) * InCookData )


description: Deprecated* CookingTarget has been moved toFArchiveCookData.

code: void SetCookingTarget ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * )


description: Sets a specific custom version

code: void SetCustomVersion ( const struct [FGuid](API\Runtime\Core\Misc\FGuid) & Key, int32 Version, [FName](API\Runtime\Core\UObject\FName) FriendlyName )


description: Sets the archiver IsCriticalError and IsError to true. Also sets CriticalError in the proxy archiver if one is wrapping this.

code: void SetCriticalError()


description: Sets the custom version numbers for this archive.

code: virtual void SetCustomVersions ( const [FCustomVersionContainer](API\Runtime\Core\Serialization\FCustomVersionContainer) & CustomVersionContainer )


description: Sets the archives custom serialization modifier flags (nothing to do with PortFlags or Custom versions)

code: void SetDebugSerializationFlags ( uint32 InCustomFlags )


description: Sets the archive engine version. Used by the code that makes sure thatFLinkerLoad's internal archive versions match the file reader it creates.

code: virtual void SetEngineVer ( const [FEngineVersionBase](API\Runtime\Core\Misc\FEngineVersionBase) & InVer )


description: Sets the archive engine network version.

code: virtual void SetEngineNetVer ( const uint32 InEngineNetVer )


description: Sets ArIsError to true. Also sets error in the proxy archiver if one is wrapping this.

code: void SetError()


description: Sets a flag indicating that this archive needs to filter editor-only content.

code: virtual void SetFilterEditorOnly ( bool InFilterEditorOnly )


description: Sets whether this archive wants to force saving as Unicode. This is needed when we need to make sure ANSI strings are saved as Unicode.

code: virtual void SetForceUnicode ( bool bInForceUnicode )


description: Sets the archive game network version.

code: virtual void SetGameNetVer ( const uint32 InGameNetVer )


description: Sets whether this archive is for loading data.

code: virtual void SetIsLoading ( bool bInIsLoading )


description: Sets whether the archive is loading from a cooked package.

code: virtual void SetIsLoadingFromCookedPackage ( bool bInIsLoadingFromCookedPackage )


description: Sets whether this archive is to persistent storage.

code: virtual void SetIsPersistent ( bool bInIsPersistent )


description: Sets whether this archive is for saving data.

code: virtual void SetIsSaving ( bool bInIsSaving )


description: Sets whether this archive is in text format.

code: virtual void SetIsTextFormat ( bool bInIsTextFormat )


description: Sets whether this archive is for transacting.

code: virtual void SetIsTransacting ( bool bInIsTransacting )


description: Deprecated* Use SetLicenseeUEVer instead

code: void SetLicenseeUE4Ver ( int32 InVer )


description: Sets the archive licensee version number. Used by the code that makes sure thatFLinkerLoad's internal archive versions match the file reader it creates.

code: virtual void SetLicenseeUEVer ( int32 InVer )


description: Set the localization namespace that this archive should use when serializing text properties. This is typically the namespace used by the package being serialized (if serializing a package, or an object within a package).

code: virtual void SetLocalizationNamespace ( const [FString](API\Runtime\Core\Containers\FString) & InLocalizationNamespace )


description: Sets the archive's property serialization modifier flags

code: void SetPortFlags ( uint32 InPortFlags )


description: Sets the currentUObjectserialization context for this archive.

code: virtual void SetSerializeContext ( [FUObjectSerializeContext](API\Runtime\CoreUObject\UObject\FUObjectSerializeContext) * InLoadContext )


description: You likely want to call PushSerializedProperty/PopSerializedProperty instead

code: virtual void SetSerializedProperty ( [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty )


description: Set the raw serialized property chain for this archive, optionally overriding the serialized property too (or null to use the head of the property chain)

code: virtual void SetSerializedPropertyChain ( const [FArchiveSerializedPropertyChain](API\Runtime\Core\Serialization\FArchiveSerializedPropertyChain) * InSerializedPropertyChain, class [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InSerializedPropertyOverride )


description: Set whether or not it is allowed to skip serialization on assets still being compiled to avoid waiting unless strictly necessary.

code: void SetShouldSkipCompilingAssets ( bool Enabled )


description: If set true, UsingCurrentVersion will not query the version registry to get the latest version data for the key if the version key is already set in the local container. Querying the version registry is not cheap, and the look up time increases as more custom versions are registered, therefore if you don't change the registered custom version data once is set in the archive Setting this to true should improve serialization performance by skipping the step entirely.

code: void SetShouldSkipUpdateCustomVersion ( bool bShouldSkip )


description: Deprecated* Use SetUEVer instead which takes the version as aFPackageFileVersion. See the  documentation for further details

code: void SetUE4Ver ( int32 InVer )


description: Sets the archive version number. Used by the code that makes sure thatFLinkerLoad's internal archive versions match the file reader it creates.

code: virtual void SetUEVer ( [FPackageFileVersion](API\Runtime\Core\UObject\FPackageFileVersion) InVer )


description: Sets whether tagged property serialization should be replaced by faster unversioned serialization. This assumes writer and reader share the same property definitions.

code: virtual void SetUseUnversionedPropertySerialization ( bool bInUseUnversioned )


description: Sets whether this archive wants binary property serialization.

code: virtual void SetWantBinaryPropertySerialization ( bool bInWantBinaryPropertySerialization )


description: Returns true if this archive should ignore bulk data.

code: bool ShouldSkipBulkData() const


description: Returns true if it is allowed to skip serialization on assets still being compiled to avoid waiting unless strictly necessary.

code: bool ShouldSkipCompilingAssets() const


description: Checks whether the archive wants to skip the property independent of the other flags

code: virtual bool ShouldSkipProperty ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty ) const


description: Returns true if this Archive is does not update the custom version data for a given key if has already been set previously in the local custom versions container


description: Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location. If this returns -1, there is no backing data storage and Seek will not function.

code: virtual int64 Tell()


description: Sets a flag indicating that this archive contains native or generated code.

code: void ThisContainsCode()


description: Sets a flag indicating that this archive contains aULevelorUWorldobject.

code: void ThisContainsMap()


description: Sets a flag indicating that this archive contains data required to be gathered for localization.

code: void ThisRequiresLocalizationGather()


description: Returns total size of the backing data storage.

code: virtual int64 TotalSize()


description: Returns the global engine serialization version used for this archive.

code: int32 UE4Ver() const


code: static void UnlinkProxy ( [FArchiveState](API\Runtime\Core\Serialization\FArchiveState) & Inner, [FArchiveState](API\Runtime\Core\Serialization\FArchiveState) & Proxy )


description:
Checks whether the archive is used to resolve out-of-date enum indexes If function returns true, the archive should be called only for objects containing user defined enum
true if the archive is used to resolve out-of-date enum indexes

code: virtual bool UseToResolveEnumerators() const


description: Returns true if tagged property serialization should be replaced by faster unversioned serialization. This assumes writer and reader share the same property definitions.


description: Returns true if this archive wants properties to be serialized in binary form instead of safer but slower tagged form.


className: FArchiveState

description: No destructors are accessible with public or protected access.

code: struct FArchiveState

ArAllowLazyLoading

type: uint8:  1

description: Whether to allow lazy loading of bulk/secondary data.

ArContainsCode

description: Quickly tell if an archive contains script code.

ArContainsMap

description: Used to determine whetherFArchivecontains a level or world.

ArCustomPropertyList

type: constFCustomPr...

description: Custom property list attribute.

ArDebugSerializationFlags

description: Custom serialization modifier flags can be used for anything

ArEngineVer

type: FEngineVersionB...

description: Holds the engine version.

ArForceByteSwapping

description: Whether we should forcefully swap bytes.

ArForceUnicode

description: Whether this archive wants to always save strings in UTF16 format even if they are ANSI characters

ArIgnoreArchetypeRef

description: If true, we will not serialize archetype references for structs and classes.

ArIgnoreClassGeneratedByRef

description: If true, we will not serialize ClassGeneratedBy reference inUClass.

ArIgnoreClassRef

description: If true,UObject::Serializewill skip serialization of the Class property.

ArIgnoreOuterRef

description: If true, we will not serialize the Outer reference inUObject.

ArIsCountingMemory

description: Whether this archive is counting memory.

ArIsFilterEditorOnly

description: Whether editor only properties are being filtered from the archive (or has been filtered).

ArIsLoading

description: Whether this archive is for loading data.

ArIsLoadingFromCookedPackage

description: Whether this archive is loading from a cooked package.

ArIsModifyingWeakAndStrongReferences

description: Whether a reference collector is modifying the references and wants both weak and strong ones

ArIsNetArchive

description: Whether or not this archive is sending/receiving network data

ArIsObjectReferenceCollector

description: Whether this archive only cares about serializing object references.

ArIsPersistent

description: Whether this archive saves to persistent storage.

ArIsSaveGame

description: Whether this archive is saving/loading game state

ArIsSaving

description: Whether this archive is for saving data.

ArIsTextFormat

description: Whether this archive serializes to a text format.

ArIsTransacting

description: Whether archive is transacting, which is used to keep track of changes to objects for things like the editor undo system.

ArLicenseeUEVer

description: Holds the archive version for licensees.

ArMaxSerializeSize

description: Max size of data that this archive is allowed to serialize.

ArNoDelta

description: If true, do not perform delta serialization of properties.

ArNoIntraPropertyDelta

description: If true, do not perform delta serialization within properties (e.g. TMaps and TSets).

ArPortFlags

description: Modifier flags that be used when serializing UProperties

ArRequiresLocalizationGather

description: Used to determine whetherFArchivecontains data required to be gathered for localization.

ArSerializingDefaults

description: Whether we are currently serializing defaults. > 0 means yes, <= 0 means no.

ArShouldSkipBulkData

description: Whether bulk data serialization should be skipped or not.

ArUEVer

type: FPackageFileVer...

description: These will be private inFArchive.

ArUseCustomPropertyList

description: Set TRUE to use the custom property list attribute for serialization.

ArUseUnversionedPropertySerialization

description: Whether tagged property serialization is replaced by faster unversioned serialization.

ArWantBinaryPropertySerialization

description: Whether this archive wants properties to be serialized in binary form instead of tagged.

bCustomVersionsAreReset

description: Indicates if the custom versions container is in a 'reset' state.

CookData

type: FArchiveCookDat...

description: These will be private inFArchive.

CustomVersionContainer

type: FCustomVersionC...

description: All the custom versions stored in the archive.

LocalizationNamespacePtr

type: FString*

description: The localization namespace that this archive should use when serializing text properties.

SerializedProperty

type: FProperty*

description: Holds the pointer to the property that is currently being serialized

SerializedPropertyChain

type: FArchiveSeriali...

description: Holds the chain of properties that are currently being serialized


description: This is overridden for the specific Archive Types

code: virtual [FString](API\Runtime\Core\Containers\FString) GetArchiveName() const


code: virtual void Serialize ( void * Data, int64 Count )


className: FArrayReader

code: class FArrayReader : public [FMemoryArchive](API\Runtime\Core\Serialization\FMemoryArchive), public [TArray< uint8 >](API\Runtime\Core\Containers\TArray)


code: virtual void SerializeBitsWithOffset ( void * Src, int32 SourceBit, int64 LengthBits )


className: FBitArchive

description: Base class for serializing bitstreams.

code: class FBitArchive : public [FArchive](API\Runtime\Core\Serialization\FArchive)


description: Default Constructor

code: FBitArchive()


description: This appends data from another BitReader. It checks that this bit reader is byte-aligned so it can just do aTArray::Appendinstead of a bitcopy. It is intended to be used by performance minded code that wants to ensure an appBitCpy is avoided.

code: void AppendDataFromChecked ( [FBitReader](API\Runtime\Core\Serialization\FBitReader) & Src )


code: void AppendDataFromChecked ( uint8 * Src, uint32 NumBits )


code: void AppendTo ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Buffer )


description: Counts the in-memory bytes used by this object

code: virtual void CountMemory ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) const


description: Returns true if the current location within the backing data storage is at the end, always returns false if there is no storage.

code: virtual bool AtEnd()


code: const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetBuffer() const


code: [FBitReader](API\Runtime\Core\Serialization\FBitReader) & operator= ( const [FBitReader](API\Runtime\Core\Serialization\FBitReader) & )


code: [FBitReader](API\Runtime\Core\Serialization\FBitReader) & operator= ( [FBitReader](API\Runtime\Core\Serialization\FBitReader) && )


description: Equivalent to SetData (reset position, copy from Src into internal buffer), but uses Reset not Empty to avoid a realloc if possible.

code: void ResetData ( [FBitReader](API\Runtime\Core\Serialization\FBitReader) & Src, int64 CountBits )


code: virtual void Serialize ( void * Dest, int64 LengthBytes )


description: Disable false positive buffer overrun warning during pgoprofile linking step.

code: virtual void SerializeBits ( void * Dest, int64 LengthBits )


code: virtual void SerializeBitsWithOffset ( void * Dest, int32 DestBit, int64 LengthBits )


description: OutValue < ValueMax.

code: virtual void SerializeInt ( uint32 & OutValue, uint32 ValueMax )


description: Packs int value into bytes of 7 bits with 8th bit for 'more'

code: virtual void SerializeIntPacked ( uint32 & Value )


description: Set the stream at the end

code: void SetAtEnd()


code: void SetData ( [FBitReader](API\Runtime\Core\Serialization\FBitReader) & Src, int64 CountBits )


code: void SetData ( uint8 * Src, int64 CountBits )


code: void SetData ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > && Src, int64 CountBits )


description: Marks this bit reader as overflowed.

code: void SetOverflowed ( int64 LengthBits )


description: Copies version information used for network compatibility from Source to this archive

code: void SetNetVersionsFromArchive ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Source )


code: FBitReader ( const [FBitReader](API\Runtime\Core\Serialization\FBitReader) & )


code: FBitReader ( [FBitReader](API\Runtime\Core\Serialization\FBitReader) && )


code: FBitReader ( const uint8 * Src, int64 CountBits )


code: void Copy ( [FBitReader](API\Runtime\Core\Serialization\FBitReader) & Reader, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Buffer )


className: FBitReader

description: Reads bitstreams.

code: struct FBitReader : public [FBitArchive](API\Runtime\Core\Serialization\FBitArchive)

Buffer

type: TArray< uint8 >


code: void Pop ( [FBitReader](API\Runtime\Core\Serialization\FBitReader) & Reader )


code: FBitReaderMark ( [FBitReader](API\Runtime\Core\Serialization\FBitReader) & Reader )


className: FBitReaderMark

description: For pushing and poppingFBitWriterpositions.

code: struct FBitReaderMark


code: bool AllowAppend ( int64 LengthBits )


code: virtual void CountMemory ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) const


code: const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > * GetBuffer() const


description: Returns a pointer to our internal buffer.

code: uint8 * GetData()


description: Returns the number of bits the buffer supports.

code: int64 GetMaxBits() const


description: Returns the number of bits written.

code: int64 GetNumBits() const


description: Returns the number of bytes written.

code: int64 GetNumBytes() const


code: [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) & operator= ( const [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) & )


code: [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) & operator= ( [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) && )


description: Resets the bit writer back to its initial state

code: virtual void Reset()


code: virtual void Serialize ( void * Src, int64 LengthBytes )


code: virtual void SerializeBits ( void * Src, int64 LengthBits )


code: virtual void SerializeBitsWithOffset ( void * Src, int32 SourceBit, int64 LengthBits )


description: Serializes a compressed integer - Value must be < Max

code: virtual void SerializeInt ( uint32 & Value, uint32 Max )


description: Sets whether or not this writer intentionally allows overflows (to avoid logspam)

code: void SetAllowOverflow ( bool bInAllow )


description: This function is bit compatible withFArchive::SerializeIntPacked. It is more efficient as only a few bytes are written and the base version is best suited for writing many bytes. This version can be made more efficient and take less bits when we can break backward compatibility. The last byte will only need 4 bits so we're currently wasting 4 bits. Another way to pack could be to store 2 bits first in order to indicate how many bytes are needed. That would eliminate all shifting and masking to reconstruct the bytes. The downside is that values less than 2^14 will waste 1-2 bits compared to the below algorithm.

code: virtual void SerializeIntPacked ( uint32 & Value )


code: void SetAllowResize ( bool NewResize )


description: Marks this bit writer as overflowed.

code: void SetOverflowed ( int32 LengthBits )


description: Serializes the specified Value, but does not bounds check against ValueMax; instead, it will wrap around if the value exceeds ValueMax (this differs from SerializeInt, which clamps)

code: void WriteIntWrapped ( uint32 Value, uint32 ValueMax )


description: Default constructor. Zeros everything.

code: FBitWriter()


code: FBitWriter ( const [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) & )


code: FBitWriter ( [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) && )


description: Constructor using known size the buffer needs to be

code: FBitWriter ( int64 InMaxBits, bool AllowResize )


className: FBitWriter

description: Writes bitstreams.

code: struct FBitWriter : public [FBitArchive](API\Runtime\Core\Serialization\FBitArchive)


description: Copies the last section into a buffer. Does not clear theFBitWriterlikePopdoes

code: void Copy ( [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) & Writer, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Buffer )


code: void Init ( [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) & Writer )


code: void Pop ( [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) & Writer )


description: Pops the BitWriter back to the start but doesn't clear what was written.

code: void PopWithoutClear ( [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) & Writer )


code: FBitWriterMark ( [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) & Writer )


className: FBitWriterMark

code: struct FBitWriterMark


className: Super

code: typedef [TBufferArchive](API\Runtime\Core\Serialization\TBufferArchive)< 32 > Super


className: FBufferArchive

description: FBufferArchiveandFBufferArchive64are implemented as derived classes rather than aliases so that forward declarations will work.

code: class FBufferArchive : public [TBufferArchive< 32 >](API\Runtime\Core\Serialization\TBufferArchive)


code: typedef [TBufferArchive](API\Runtime\Core\Serialization\TBufferArchive)< 64 > Super


code: class FBufferArchive64 : public [TBufferArchive< 64 >](API\Runtime\Core\Serialization\TBufferArchive)


description: This is overridden for the specific Archive Types

code: virtual [FString](API\Runtime\Core\Containers\FString) GetArchiveName() const


description: Constructor

code: FBufferReader ( void * Data, int64 Size, bool bInFreeOnClose, bool bIsPersistent )


className: FBufferReader

description: Similar toFMemoryReader, but able to internally manage the memory for the buffer.

code: class FBufferReader : public [FBufferReaderBase](API\Runtime\Core\Serialization\FBufferReaderBase)


description: Returns true if the current location within the backing data storage is at the end, always returns false if there is no storage.

code: virtual bool AtEnd()


description: Attempts to close and finalize any handles used for backing data storage, returns true if it succeeded.

code: virtual bool Close()


description: Attempts to set the current offset into backing data storage, this will do nothing if there is no storage.

code: virtual void Seek ( int64 InPos )


code: virtual void Serialize ( void * Data, int64 Num )


description: Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location. If this returns -1, there is no backing data storage and Seek will not function.

code: virtual int64 Tell()


description: Returns total size of the backing data storage.

code: virtual int64 TotalSize()


description: Constructor

code: FBufferReaderBase ( void * Data, int64 Size, bool bInFreeOnClose, bool bIsPersistent )


description: Abstract to force implementors to callClose()themselves, since it's a virtual function.

code: ~FBufferReaderBase()


className: FBufferReaderBase

code: class FBufferReaderBase : public [FArchive](API\Runtime\Core\Serialization\FArchive)

bFreeOnClose

type: bool

ReaderData

type: void *


description: Constructor

code: FBufferWriter ( void * Data, int64 Size, EBufferWriterFlags InFlags )


className: FBufferWriter

description: Similar toFMemoryWriter, but able to internally manage the memory for the buffer.

code: class FBufferWriter : public [FArchive](API\Runtime\Core\Serialization\FArchive)


description: Access the array as an array field.


description: Returns a buffer that contains the array as it would be serialized by CopyTo.


className: FCbArray

description: TCbBuffer

code: class FCbArray : public [TCbBuffer< FCbArrayView >](API\Runtime\Core\Serialization\TCbBuffer), public [TCbBufferFactory< FCbArray, FCbArrayView >](API\Runtime\Core\Serialization\TCbBufferFactory)


description: Append the hash of the array if serialized by itself with no name.

code: void AppendHash ( [FIoHashBuilder](API\Runtime\Core\IO\FIoHashBuilder) & Builder ) const


description: Copy the array into a buffer of exactlyGetSize()bytes, with no name.

code: void CopyTo ( FMutableMemoryView Buffer ) const


description: Copy the array into an archive. This will writeGetSize()bytes, with no name.

code: void CopyTo ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) const


description: Performs a deep comparison of any contained arrays or objects and their fields. Comparison assumes that both fields are valid and are written in the canonical format. Fields must be written in the same order in arrays and objects, and name comparison is case sensitive. If these assumptions do not hold, this may return false for equivalent inputs. Validation can be done with the All mode to check these assumptions about the format of the inputs.

code: bool Equals ( const [FCbArrayView](API\Runtime\Core\Serialization\FCbArrayView) & Other ) const


description: Construct an array from an array field. No type check is performed!

code: static [FCbArrayView](API\Runtime\Core\Serialization\FCbArrayView) FromFieldNoCheck ( const [FCbFieldView](API\Runtime\Core\Serialization\FCbFieldView) & Field )


description: Calculate the hash of the array if serialized by itself with no name.


description: Returns the size of the array in bytes if serialized by itself with no name.

code: uint64 GetSize() const


description: Invoke the visitor for every attachment in the array.

code: void IterateAttachments ( FCbFieldVisitor Visitor ) const


description: Returns the number of items in the array.

code: uint64 Num() const


className: FCbArrayView::operator bool

description: Whether the array has any fields.

code: operator bool() const


description: A view is available if the array contains its type and has no name. Access the equivalent for other arrays throughFCbArray::GetBuffer,FCbArray::Clone, or CopyTo.

code: bool TryGetView ( FMemoryView & OutView ) const


description: Construct an array with no fields.

code: FCbArrayView()


description: Construct an array from an array field. No type check is performed! Use via FromFieldNoCheck.

code: FCbArrayView &40; const FCbFieldView & Field &41;


className: FCbArrayView

description: This type only provides a view into memory and does not perform any memory management itself. UseFCbArrayto hold a reference to the underlying memory when necessary.

code: class FCbArrayView : protected [FCbFieldView](API\Runtime\Core\Serialization\FCbFieldView)


description: Access the attachment as raw binary in a single contiguous buffer. Defaults to a null buffer on error.


description: Access the attachment as compressed binary. Defaults to a null buffer on error.

code: const [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) & AsCompressedBinary() const


description: Access the attachment as raw binary. Defaults to a null buffer on error.

code: const [FCompositeBuffer](API\Runtime\Core\Memory\FCompositeBuffer) & AsCompositeBinary() const


description: Access the attachment as an object. Defaults to an empty object on error.


description: Returns the hash of the attachment value.


description: Returns whether the attachment is raw binary.

code: bool IsBinary() const


description: Returns whether the attachment is compressed binary.

code: bool IsCompressedBinary() const


description: Whether the attachment has a null value.

code: bool IsNull() const


className: FCbAttachment::operator bool

description: Whether the attachment has a non-null value.


description: Returns whether the attachment is an object.

code: bool IsObject() const


description: Compares attachments by their hash. Any discrepancy in type must be handled externally.

code: bool operator== ( const [FCbAttachment](API\Runtime\Core\Serialization\FCbAttachment) & Attachment ) const


code: bool operator!= ( const [FCbAttachment](API\Runtime\Core\Serialization\FCbAttachment) & Attachment ) const


code: bool operator< ( const [FCbAttachment](API\Runtime\Core\Serialization\FCbAttachment) & Attachment ) const


description: Reset this to a null attachment.

code: void Reset()


description: Save the attachment into the writer as a stream of compact binary fields.

code: void Save ( [FCbWriter](API\Runtime\Core\Serialization\FCbWriter) & Writer ) const


description: Save the attachment into the archive as a stream of compact binary fields.

code: void Save ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) const


description: The iterator is advanced as attachment fields are consumed from it.

code: bool TryLoad ( [FCbFieldIterator](API\Runtime\Core\Serialization\FCbFieldIterator) & Fields )


description: Allocated buffers will be cloned if they are not owned.

code: bool TryLoad ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, FCbBufferAllocator Allocator )


description: Construct a null attachment.

code: FCbAttachment()


description: An attachment is serialized as a sequence of compact binary fields with no name. It is invalid to serialize a null attachment. A raw binary attachment is serialized as an empty Binary field when empty, and otherwise as a BinaryAttachment field containing the raw hash, followed by the raw binary data in a Binary field. A compressed binary attachment is serialized as Binary with a compressed buffer as the value. An object is serialized as an empty Object field when empty, and otherwise as an ObjectAttachment field containing the hash, followed by the object data in an Object field.

code: template<typename BufferType, decltype(FBinaryValue(DeclVal< BufferType >().MakeOwned()))*> FCbAttachment ( BufferType && InValue, const [FIoHash](API\Runtime\Core\IO\FIoHash) & InHash )


description: Construct an object attachment. Value is cloned if not owned.

code: FCbAttachment ( const [FCbObject](API\Runtime\Core\Serialization\FCbObject) & InValue )


code: FCbAttachment ( [FCbObject](API\Runtime\Core\Serialization\FCbObject) && InValue )


description: Construct a raw binary attachment from a shared/composite buffer. Value is cloned if not owned.

code: template<typename BufferType, decltype(FBinaryValue(DeclVal< BufferType >().MakeOwned()))*> FCbAttachment ( BufferType && InValue )


description: Construct a compressed binary attachment. Value is cloned if not owned.

code: FCbAttachment ( const [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) & InValue )


code: FCbAttachment ( const [FCbObject](API\Runtime\Core\Serialization\FCbObject) & InValue, const [FIoHash](API\Runtime\Core\IO\FIoHash) & Hash )


code: FCbAttachment ( [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) && InValue )


code: template<typename... ArgTypes, decltype(FBinaryValue(DeclVal< ArgTypes >()...))&42;> FCbAttachment &40; TInPlaceType< FBinaryValue >, ArgTypes &&... Args &41;


code: FCbAttachment ( [FCbObject](API\Runtime\Core\Serialization\FCbObject) && InValue, const [FIoHash](API\Runtime\Core\IO\FIoHash) & Hash )


className: FCbCustomById

description: A custom compact binary field type with an integer identifier.

code: struct FCbCustomById

Data

type: FMemoryView

description: A view of the value. Lifetime is tied to the field that the value is associated with.

Id

description: An identifier for the sub-type of the field.


className: FCbCustomByName

description: A custom compact binary field type with a string identifier.

code: struct FCbCustomByName


description: Access the field as an array. Defaults to an empty array on error.


className: FCbAttachment

code: class FCbAttachment


description: Access the field as binary. Returns the provided default on error.

code: [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) AsBinary ( const [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) & Default )


description: Access the field as an object. Defaults to an empty object on error.


description: Returns a buffer that contains the field as it would be serialized by CopyTo.


className: FCbField

description: TCbBuffer

code: class FCbField : public [TCbBuffer< FCbFieldView >](API\Runtime\Core\Serialization\TCbBuffer), public [TCbBufferFactory< FCbField, FCbFieldView >](API\Runtime\Core\Serialization\TCbBufferFactory)


description: Construct a field range from an owned clone of a range.

code: static [FCbFieldIterator](API\Runtime\Core\Serialization\FCbFieldIterator) CloneRange ( const [FCbFieldViewIterator](API\Runtime\Core\Serialization\FCbFieldViewIterator) & It )


code: static [FCbFieldIterator](API\Runtime\Core\Serialization\FCbFieldIterator) CloneRange ( const [FCbFieldIterator](API\Runtime\Core\Serialization\FCbFieldIterator) & It )


description: Construct a field range from a buffer containing zero or more valid fields.

code: static [FCbFieldIterator](API\Runtime\Core\Serialization\FCbFieldIterator) MakeRange ( [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) Buffer, ECbFieldType Type )


description: Clone the range, if necessary, to a buffer that this has ownership of.

code: void MakeRangeOwned()


description: Construct a field range that contains exactly one field.

code: static [FCbFieldIterator](API\Runtime\Core\Serialization\FCbFieldIterator) MakeSingle ( [FCbField](API\Runtime\Core\Serialization\FCbField) Field )


description: Construct a field range from an iterator and its optional outer buffer.

code: static [FCbFieldIterator](API\Runtime\Core\Serialization\FCbFieldIterator) MakeRangeView ( const [FCbFieldViewIterator](API\Runtime\Core\Serialization\FCbFieldViewIterator) & It, [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) OuterBuffer )


description: Construct an empty field range.

code: constexpr FCbFieldIterator()


className: FCbFieldIterator

description: TCbFieldIterator

code: class FCbFieldIterator : public [TCbFieldIterator< FCbField >](API\Runtime\Core\Serialization\TCbFieldIterator)


className: ArrayBase

description: DO NOT CHANGE THE VALUE OF ANY MEMBERS OF THIS ENUM! BACKWARD COMPATIBILITY REQUIRES THAT THESE VALUES BE FIXED! SERIALIZATION USES HARD-CODED CONSTANTS BASED ON THESE VALUES!

code: static constexpr ECbFieldType ArrayBase = ECbFieldType(0b0000'0100);


className: ArrayMask

code: static constexpr ECbFieldType ArrayMask = ECbFieldType(0b0001'1110);


className: AttachmentBase

code: static constexpr ECbFieldType AttachmentBase = ECbFieldType(0b0000'1110);


className: AttachmentMask

code: static constexpr ECbFieldType AttachmentMask = ECbFieldType(0b0001'1110);


className: BoolBase

code: static constexpr ECbFieldType BoolBase = ECbFieldType(0b0000'1100);


className: BoolMask

code: static constexpr ECbFieldType BoolMask = ECbFieldType(0b0001'1110);


className: FloatBase

code: static constexpr ECbFieldType FloatBase = ECbFieldType(0b0000'1000);


className: FloatMask

code: static constexpr ECbFieldType FloatMask = ECbFieldType(0b0001'1100);


description: The type with flags removed.

code: static constexpr ECbFieldType GetType ( ECbFieldType Type )


description: The type with transient flags removed.

code: static constexpr ECbFieldType GetSerializedType ( ECbFieldType Type )


code: static constexpr bool HasFields ( ECbFieldType Type )


code: static constexpr bool HasFieldName ( ECbFieldType Type )


code: static constexpr bool HasFieldType ( ECbFieldType Type )


className: IntegerBase

code: static constexpr ECbFieldType IntegerBase = ECbFieldType(0b0000'1000);


code: static constexpr bool HasUniformFields ( ECbFieldType Type )


className: IntegerMask

code: static constexpr ECbFieldType IntegerMask = ECbFieldType(0b0001'1110);


code: static constexpr bool IsArray ( ECbFieldType Type )


code: static constexpr bool IsAttachment ( ECbFieldType Type )


code: static constexpr bool IsBinaryAttachment ( ECbFieldType Type )


code: static constexpr bool IsBinary ( ECbFieldType Type )


code: static constexpr bool IsCustomById ( ECbFieldType Type )


code: static constexpr bool IsBool ( ECbFieldType Type )


code: static constexpr bool IsCustomByName ( ECbFieldType Type )


code: static constexpr bool IsDateTime ( ECbFieldType Type )


description: Whether the field is a float, or integer due to implicit conversion.

code: static constexpr bool IsFloat ( ECbFieldType Type )


code: static constexpr bool IsHash ( ECbFieldType Type )


code: static constexpr bool IsInteger ( ECbFieldType Type )


code: static constexpr bool IsNone ( ECbFieldType Type )


code: static constexpr bool IsNull ( ECbFieldType Type )


code: static constexpr bool IsObject ( ECbFieldType Type )


code: static constexpr bool IsObjectAttachment ( ECbFieldType Type )


code: static constexpr bool IsObjectId ( ECbFieldType Type )


code: static constexpr bool IsString ( ECbFieldType Type )


code: static constexpr bool IsTimeSpan ( ECbFieldType Type )


code: static constexpr bool IsUuid ( ECbFieldType Type )


description: Whether the type is or may contain fields of any attachment type.

code: static constexpr bool MayContainAttachments ( ECbFieldType Type )


className: ObjectMask

code: static constexpr ECbFieldType ObjectMask = ECbFieldType(0b0001'1110);


className: ObjectBase

code: static constexpr ECbFieldType ObjectBase = ECbFieldType(0b0000'0010);


className: SerializedTypeMask

code: static constexpr ECbFieldType SerializedTypeMask = ECbFieldType(0b1001'1111);


className: TypeMask

code: static constexpr ECbFieldType TypeMask = ECbFieldType(0b0001'1111);


className: FCbFieldType

description: Functions that operate on ECbFieldType.

code: class FCbFieldType


description: Append the hash of the field, including the type and name.

code: void AppendHash ( [FIoHashBuilder](API\Runtime\Core\IO\FIoHashBuilder) & Builder ) const


description: Access the field as a hash referencing an attachment. Returns the provided default on error.

code: [FIoHash](API\Runtime\Core\IO\FIoHash) AsAttachment ( const [FIoHash](API\Runtime\Core\IO\FIoHash) & Default )


description: Access the field as a hash referencing a binary attachment. Returns the provided default on error.

code: [FIoHash](API\Runtime\Core\IO\FIoHash) AsBinaryAttachment ( const [FIoHash](API\Runtime\Core\IO\FIoHash) & Default )


description: Access the field as a bool. Returns the provided default on error.

code: bool AsBool ( bool bDefault )


code: FMemoryView AsBinaryView ( FMemoryView Default )


description: Access the field as a custom sub-type with an integer identifier. Returns the provided default on error.

code: FMemoryView AsCustom ( uint64 Id, FMemoryView Default )


description: Access the field as a custom sub-type with a string identifier. Returns the provided default on error.

code: FMemoryView AsCustom ( FUtf8StringView Name, FMemoryView Default )


code: [FCbCustomById](API\Runtime\Core\Serialization\FCbCustomById) AsCustomById ( [FCbCustomById](API\Runtime\Core\Serialization\FCbCustomById) Default )


code: [FCbCustomByName](API\Runtime\Core\Serialization\FCbCustomByName) AsCustomByName ( [FCbCustomByName](API\Runtime\Core\Serialization\FCbCustomByName) Default )


description: Access the field as a date/time. Returns a date/time at the epoch on error.


description: Access the field as a date/time tick count. Returns the provided default on error.

code: int64 AsDateTimeTicks ( int64 Default )


description: Access the field as a double. Returns the provided default on error.

code: double AsDouble ( double Default )


description: Access the field as a float. Returns the provided default on error.

code: float AsFloat ( float Default )


description: Access the field as a hash. Returns the provided default on error.

code: [FIoHash](API\Runtime\Core\IO\FIoHash) AsHash ( const [FIoHash](API\Runtime\Core\IO\FIoHash) & Default )


description: Access the field as an int16. Returns the provided default on error.

code: int16 AsInt16 ( int16 Default )


description: Access the field as an int64. Returns the provided default on error.

code: int64 AsInt64 ( int64 Default )


description: Access the field as a date/time. Returns the provided default on error.

code: [FDateTime](API\Runtime\Core\Misc\FDateTime) AsDateTime ( [FDateTime](API\Runtime\Core\Misc\FDateTime) Default )


description: Access the field as an int32. Returns the provided default on error.

code: int32 AsInt32 ( int32 Default )


description: Access the field as an int8. Returns the provided default on error.

code: int8 AsInt8 ( int8 Default )


description: Access the field as a hash referencing an object attachment. Returns the provided default on error.

code: [FIoHash](API\Runtime\Core\IO\FIoHash) AsObjectAttachment ( const [FIoHash](API\Runtime\Core\IO\FIoHash) & Default )


description: Access the field as an object identifier. Returns the provided default on error.

code: [FCbObjectId](API\Runtime\Core\Serialization\FCbObjectId) AsObjectId ( const [FCbObjectId](API\Runtime\Core\Serialization\FCbObjectId) & Default )


description: Access the field as an object. Defaults to an empty object on error.


description: Assign a field from a pointer to its data and an optional externally-provided type.

code: void Assign ( const void * InData, const ECbFieldType InType )


description: Access the field as a string. Returns the provided default on error.

code: FUtf8StringView AsString ( FUtf8StringView Default )


description: Access the field as a timespan. Returns an empty timespan on error.


description: Access the field as a timespan. Returns the provided default on error.

code: [FTimespan](API\Runtime\Core\Misc\FTimespan) AsTimeSpan ( [FTimespan](API\Runtime\Core\Misc\FTimespan) Default )


description: Access the field as a timespan tick count. Returns the provided default on error.

code: int64 AsTimeSpanTicks ( int64 Default )


description: Access the field as a uint16. Returns the provided default on error.

code: uint16 AsUInt16 ( uint16 Default )


description: Access the field as a uint32. Returns the provided default on error.

code: uint32 AsUInt32 ( uint32 Default )


description: Access the field as a uint64. Returns the provided default on error.

code: uint64 AsUInt64 ( uint64 Default )


description: Access the field as a uint8. Returns the provided default on error.

code: uint8 AsUInt8 ( uint8 Default )


description: Access the field as a UUID. Returns a nil UUID on error.


description: Access the field as a UUID. Returns the provided default on error.

code: [FGuid](API\Runtime\Core\Misc\FGuid) AsUuid ( const [FGuid](API\Runtime\Core\Misc\FGuid) & Default )


description: DO NOT USE DIRECTLY. These functions enable range-based for loop support.


description: Copy the field into a buffer of exactlyGetSize()bytes, including the type and name.

code: void CopyTo ( FMutableMemoryView Buffer ) const


description: Copy the field into an archive, including its type and name.

code: void CopyTo ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) const


description: Create an iterator for the fields of an array or object, otherwise an empty iterator.


code: constexpr [FCbIteratorSentinel](API\Runtime\Core\Serialization\FCbIteratorSentinel) end() const


description: Performs a deep comparison of any contained arrays or objects and their fields. Comparison assumes that both fields are valid and are written in the canonical format. Fields must be written in the same order in arrays and objects, and name comparison is case sensitive. If these assumptions do not hold, this may return false for equivalent inputs. Validation can be performed with ValidateCompactBinary, except for field order and field name case.

code: bool Equals ( const [FCbFieldView](API\Runtime\Core\Serialization\FCbFieldView) & Other ) const


description: The type of error that occurred on the last field access, or None.

code: constexpr ECbFieldError GetError() const


description: Calculate the hash of the field, including the type and name.


description: Returns the name of the field if it has a name, otherwise an empty view.

code: constexpr FUtf8StringView GetName() const