ArchiveOffset | Unreal Engine 5.6 Documentation

API > API/Plugins > API/Plugins/RigLogicLib

ArchiveOffset is a type that stores an absolute stream offset (both in-memory and writes that value into the stream as well). It has an accompanying Proxy type, which is a virtual, utility type, and they work together to achieve the function of ArchiveOffset. When ArchiveOffset is encountered during the serialization process, at first an empty offset (zero) value will be written into the stream and the position of that offset value will be captured in an in-memory variable. Later, when its associated ArchiveOffset::Proxy is encountered, the current stream position will be captured, and it will update the in-memory value of its ArchiveOffset with it. Then, it will seek the stream to the earlier captured position of the offset value (where zeros were written initially), and it will write the offset value captured by the proxy into the stream. Lastly, it will seek back to the position of the stream before the proxy was encountered, and resume serialization.


Name	ArchiveOffset
Type	struct
Header File	/Engine/Plugins/Animation/RigLogic/Source/RigLogicLib/Public/terse/types/ArchiveOffset.h
Include Path	#include "terse/types/ArchiveOffset.h"

Syntax

template<typename TOffset>  
struct ArchiveOffset

Constructors

Name	Remarks	Include Path	Unreal Specifiers
ArchiveOffset ()		terse/types/ArchiveOffset.h
ArchiveOffset ( const ArchiveOffset& )		terse/types/ArchiveOffset.h
ArchiveOffset ( ArchiveOffset&& rhs )		terse/types/ArchiveOffset.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
~ArchiveOffset()		terse/types/ArchiveOffset.h

Structs

Name	Remarks
Proxy

Typedefs

Name	Type	Remarks	Include Path
ValueType	TOffset		terse/types/ArchiveOffset.h

Variables

Public

Name	Type	Remarks	Include Path
position	std::size_t	The position of the marker itself in the stream (this is a runtime-only value which is not written to the file, needed only for the serializer to know where to seek within the stream when the marker's actual value needs to be written)	terse/types/ArchiveOffset.h
proxy	Proxy *	When offset is moved, it's associated proxy must be updated about the new address.	terse/types/ArchiveOffset.h
value	ValueType	The position in the stream where the marker wants to point (this is the actual value that is written to the file)	terse/types/ArchiveOffset.h

Functions

Public

Operators

Name	Remarks	Include Path	Unreal Specifiers
ArchiveOffset & operator= ( const ArchiveOffset& )		terse/types/ArchiveOffset.h
ArchiveOffset & operator= ( ArchiveOffset&& rhs )		terse/types/ArchiveOffset.h

Navigation

Syntax

Constructors

Destructors

Structs

Typedefs

Variables

Public

Functions

Public

Operators