1. Epic GamesDeveloper
  3. FStructuredArchiveFormatter

FStructuredArchiveFormatter

Interface to format data to and from an underlying archive.

API > API/Runtime > API/Runtime/Core

Interface to format data to and from an underlying archive. Methods on this class are validated to be correct with the current archive state (eg. EnterObject/LeaveObject calls are checked to be matching), and do not need to be validated by implementations.

Any functions with the _TextOnly suffix are intended to be implemented when reading text archives that have a fully defined document tree, and allow querying additional properties that aren't available when reading from a pure binary archive. These functions will assert if called on a binary archive.

   
Name FStructuredArchiveFormatter
Type class
Header File /Engine/Source/Runtime/Core/Public/Serialization/StructuredArchiveFormatter.h
Include Path #include "Serialization/StructuredArchiveFormatter.h"

Syntax

class FStructuredArchiveFormatter

Derived Classes

FStructuredArchiveFormatter derived class hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FStructuredArchiveFormatter()

   Serialization/StructuredArchiveFormatter.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual FStructuredArchiveFormatter * CreateSubtreeReader()

   Serialization/StructuredArchiveFormatter.h  

void EnterArray ( int32& NumElements
)

   Serialization/StructuredArchiveFormatter.h  

void EnterArrayElement()

   Serialization/StructuredArchiveFormatter.h  

void EnterAttribute ( FArchiveFieldName AttributeName
)

   Serialization/StructuredArchiveFormatter.h  

void EnterAttributedValue()

   Serialization/StructuredArchiveFormatter.h  

void EnterAttributedValueValue()

   Serialization/StructuredArchiveFormatter.h  

void EnterField ( FArchiveFieldName Name
)

   Serialization/StructuredArchiveFormatter.h  

void EnterMap ( int32& NumElements
)

   Serialization/StructuredArchiveFormatter.h  

void EnterMapElement ( FString& Name
)

   Serialization/StructuredArchiveFormatter.h  

void EnterRecord()

   Serialization/StructuredArchiveFormatter.h  

void EnterStream()

   Serialization/StructuredArchiveFormatter.h  

void EnterStreamElement()

   Serialization/StructuredArchiveFormatter.h  

FArchive & GetUnderlyingArchive()

   Serialization/StructuredArchiveFormatter.h  

bool HasDocumentTree()

   Serialization/StructuredArchiveFormatter.h  

void LeaveArray()

   Serialization/StructuredArchiveFormatter.h  

void LeaveArrayElement()

   Serialization/StructuredArchiveFormatter.h  

void LeaveAttribute()

   Serialization/StructuredArchiveFormatter.h  

void LeaveAttributedValue()

   Serialization/StructuredArchiveFormatter.h  

void LeaveField()

   Serialization/StructuredArchiveFormatter.h  

void LeaveMap()

   Serialization/StructuredArchiveFormatter.h  

void LeaveMapElement()

   Serialization/StructuredArchiveFormatter.h  

void LeaveRecord()

   Serialization/StructuredArchiveFormatter.h  

void LeaveStream()

   Serialization/StructuredArchiveFormatter.h  

void LeaveStreamElement()

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( UTF32CHAR& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( FString& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( FName& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( UObject*& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( FText& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( FSoftObjectPath& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( FSoftObjectPtr& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( bool& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( FLazyObjectPtr& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( FObjectPtr& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( FWeakObjectPtr& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( double& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( void* Data,
uint64 DataSize
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( int64& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( int32& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( int16& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( int8& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( uint64& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( uint32& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( uint16& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( uint8& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( TArray< uint8 >& Value
)

   Serialization/StructuredArchiveFormatter.h  

void Serialize ( float& Value
)

   Serialization/StructuredArchiveFormatter.h  

bool TryEnterAttribute ( FArchiveFieldName AttributeName,
bool bEnterWhenWriting
)

   Serialization/StructuredArchiveFormatter.h  

bool TryEnterAttributedValueValue()

   Serialization/StructuredArchiveFormatter.h  

bool TryEnterField ( FArchiveFieldName Name,
bool bEnterWhenWriting
)

   Serialization/StructuredArchiveFormatter.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page