Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | List of all members
FStructuredArchiveFormatter Class Referenceabstract

#include <StructuredArchiveFormatter.h>

+ Inheritance diagram for FStructuredArchiveFormatter:

Public Member Functions

virtual ~FStructuredArchiveFormatter ()
 
virtual FArchive & GetUnderlyingArchive ()=0
 
virtual FStructuredArchiveFormatter * CreateSubtreeReader ()
 
virtual bool HasDocumentTree () const =0
 
virtual void EnterRecord ()=0
 
virtual void LeaveRecord ()=0
 
virtual void EnterField (FArchiveFieldName Name)=0
 
virtual void LeaveField ()=0
 
virtual bool TryEnterField (FArchiveFieldName Name, bool bEnterWhenWriting)=0
 
virtual void EnterArray (int32 &NumElements)=0
 
virtual void LeaveArray ()=0
 
virtual void EnterArrayElement ()=0
 
virtual void LeaveArrayElement ()=0
 
virtual void EnterStream ()=0
 
virtual void LeaveStream ()=0
 
virtual void EnterStreamElement ()=0
 
virtual void LeaveStreamElement ()=0
 
virtual void EnterMap (int32 &NumElements)=0
 
virtual void LeaveMap ()=0
 
virtual void EnterMapElement (FString &Name)=0
 
virtual void LeaveMapElement ()=0
 
virtual void EnterAttributedValue ()=0
 
virtual void EnterAttribute (FArchiveFieldName AttributeName)=0
 
virtual void EnterAttributedValueValue ()=0
 
virtual void LeaveAttribute ()=0
 
virtual void LeaveAttributedValue ()=0
 
virtual bool TryEnterAttribute (FArchiveFieldName AttributeName, bool bEnterWhenWriting)=0
 
virtual bool TryEnterAttributedValueValue ()=0
 
virtual void Serialize (uint8 &Value)=0
 
virtual void Serialize (uint16 &Value)=0
 
virtual void Serialize (uint32 &Value)=0
 
virtual void Serialize (uint64 &Value)=0
 
virtual void Serialize (int8 &Value)=0
 
virtual void Serialize (int16 &Value)=0
 
virtual void Serialize (int32 &Value)=0
 
virtual void Serialize (int64 &Value)=0
 
virtual void Serialize (float &Value)=0
 
virtual void Serialize (double &Value)=0
 
virtual void Serialize (bool &Value)=0
 
virtual void Serialize (FString &Value)=0
 
virtual void Serialize (FName &Value)=0
 
virtual void Serialize (UObject *&Value)=0
 
virtual void Serialize (FText &Value)=0
 
virtual void Serialize (struct FWeakObjectPtr &Value)=0
 
virtual void Serialize (struct FSoftObjectPtr &Value)=0
 
virtual void Serialize (struct FSoftObjectPath &Value)=0
 
virtual void Serialize (struct FLazyObjectPtr &Value)=0
 
virtual void Serialize (struct FObjectPtr &Value)=0
 
virtual void Serialize (TArray< uint8 > &Value)=0
 
virtual void Serialize (void *Data, uint64 DataSize)=0
 

Detailed Description

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.

Definition at line 59 of file StructuredArchiveFormatter.h.

Constructor & Destructor Documentation

◆ ~FStructuredArchiveFormatter()

virtual FStructuredArchiveFormatter::~FStructuredArchiveFormatter ( )
virtual

Member Function Documentation

◆ CreateSubtreeReader()

virtual FStructuredArchiveFormatter * FStructuredArchiveFormatter::CreateSubtreeReader ( )
inlinevirtual

Definition at line 65 of file StructuredArchiveFormatter.h.

◆ EnterArray()

virtual void FStructuredArchiveFormatter::EnterArray ( int32 & NumElements)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ EnterArrayElement()

virtual void FStructuredArchiveFormatter::EnterArrayElement ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ EnterAttribute()

virtual void FStructuredArchiveFormatter::EnterAttribute ( FArchiveFieldName AttributeName)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ EnterAttributedValue()

virtual void FStructuredArchiveFormatter::EnterAttributedValue ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ EnterAttributedValueValue()

virtual void FStructuredArchiveFormatter::EnterAttributedValueValue ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ EnterField()

virtual void FStructuredArchiveFormatter::EnterField ( FArchiveFieldName Name)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ EnterMap()

virtual void FStructuredArchiveFormatter::EnterMap ( int32 & NumElements)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ EnterMapElement()

virtual void FStructuredArchiveFormatter::EnterMapElement ( FString & Name)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ EnterRecord()

virtual void FStructuredArchiveFormatter::EnterRecord ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ EnterStream()

virtual void FStructuredArchiveFormatter::EnterStream ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ EnterStreamElement()

virtual void FStructuredArchiveFormatter::EnterStreamElement ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ GetUnderlyingArchive()

virtual FArchive & FStructuredArchiveFormatter::GetUnderlyingArchive ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ HasDocumentTree()

virtual bool FStructuredArchiveFormatter::HasDocumentTree ( ) const
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ LeaveArray()

virtual void FStructuredArchiveFormatter::LeaveArray ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ LeaveArrayElement()

virtual void FStructuredArchiveFormatter::LeaveArrayElement ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ LeaveAttribute()

virtual void FStructuredArchiveFormatter::LeaveAttribute ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ LeaveAttributedValue()

virtual void FStructuredArchiveFormatter::LeaveAttributedValue ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ LeaveField()

virtual void FStructuredArchiveFormatter::LeaveField ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ LeaveMap()

virtual void FStructuredArchiveFormatter::LeaveMap ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ LeaveMapElement()

virtual void FStructuredArchiveFormatter::LeaveMapElement ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ LeaveRecord()

virtual void FStructuredArchiveFormatter::LeaveRecord ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ LeaveStream()

virtual void FStructuredArchiveFormatter::LeaveStream ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ LeaveStreamElement()

virtual void FStructuredArchiveFormatter::LeaveStreamElement ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [1/22]

virtual void FStructuredArchiveFormatter::Serialize ( bool & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [2/22]

virtual void FStructuredArchiveFormatter::Serialize ( double & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [3/22]

virtual void FStructuredArchiveFormatter::Serialize ( float & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [4/22]

virtual void FStructuredArchiveFormatter::Serialize ( FName & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [5/22]

virtual void FStructuredArchiveFormatter::Serialize ( FString & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [6/22]

virtual void FStructuredArchiveFormatter::Serialize ( FText & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [7/22]

virtual void FStructuredArchiveFormatter::Serialize ( int16 & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [8/22]

virtual void FStructuredArchiveFormatter::Serialize ( int32 & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [9/22]

virtual void FStructuredArchiveFormatter::Serialize ( int64 & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [10/22]

virtual void FStructuredArchiveFormatter::Serialize ( int8 & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [11/22]

virtual void FStructuredArchiveFormatter::Serialize ( struct FLazyObjectPtr & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [12/22]

virtual void FStructuredArchiveFormatter::Serialize ( struct FObjectPtr & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [13/22]

virtual void FStructuredArchiveFormatter::Serialize ( struct FSoftObjectPath & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [14/22]

virtual void FStructuredArchiveFormatter::Serialize ( struct FSoftObjectPtr & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [15/22]

virtual void FStructuredArchiveFormatter::Serialize ( struct FWeakObjectPtr & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [16/22]

virtual void FStructuredArchiveFormatter::Serialize ( TArray< uint8 > & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [17/22]

virtual void FStructuredArchiveFormatter::Serialize ( uint16 & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [18/22]

virtual void FStructuredArchiveFormatter::Serialize ( uint32 & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [19/22]

virtual void FStructuredArchiveFormatter::Serialize ( uint64 & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [20/22]

virtual void FStructuredArchiveFormatter::Serialize ( uint8 & Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [21/22]

virtual void FStructuredArchiveFormatter::Serialize ( UObject *& Value)
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ Serialize() [22/22]

virtual void FStructuredArchiveFormatter::Serialize ( void * Data,
uint64 DataSize )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ TryEnterAttribute()

virtual bool FStructuredArchiveFormatter::TryEnterAttribute ( FArchiveFieldName AttributeName,
bool bEnterWhenWriting )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ TryEnterAttributedValueValue()

virtual bool FStructuredArchiveFormatter::TryEnterAttributedValueValue ( )
pure virtual

Implemented in FBinaryArchiveFormatter.

◆ TryEnterField()

virtual bool FStructuredArchiveFormatter::TryEnterField ( FArchiveFieldName Name,
bool bEnterWhenWriting )
pure virtual

Implemented in FBinaryArchiveFormatter.

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