#include <CoreNet.h>

Inheritance diagram for FNetBitReader:

Public Member Functions
COREUOBJECT_API	FNetBitReader (UPackageMap InPackageMap=nullptr, const uint8 Src=nullptr, int64 CountBits=0)

COREUOBJECT_API	FNetBitReader (const FNetBitReader &)

COREUOBJECT_API FNetBitReader &	operator= (const FNetBitReader &)

COREUOBJECT_API	FNetBitReader (FNetBitReader &&)

COREUOBJECT_API FNetBitReader &	operator= (FNetBitReader &&)

virtual COREUOBJECT_API	~FNetBitReader ()

virtual COREUOBJECT_API FArchive &	operator<< (FName &Name) override

virtual COREUOBJECT_API FArchive &	operator<< (UObject *&Object) override

virtual COREUOBJECT_API FArchive &	operator<< (FSoftObjectPath &Value) override

virtual COREUOBJECT_API FArchive &	operator<< (FSoftObjectPtr &Value) override

virtual COREUOBJECT_API FArchive &	operator<< (FObjectPtr &Value) override

virtual COREUOBJECT_API FArchive &	operator<< (struct FWeakObjectPtr &Value) override

virtual COREUOBJECT_API void	CountMemory (FArchive &Ar) const override

Public Member Functions inherited from FBitReader
CORE_API	FBitReader (const uint8 *Src=nullptr, int64 CountBits=0)

CORE_API	~FBitReader ()

CORE_API	FBitReader (const FBitReader &)

CORE_API FBitReader &	operator= (const FBitReader &)

CORE_API	FBitReader (FBitReader &&)

CORE_API FBitReader &	operator= (FBitReader &&)

CORE_API void	SetData (FBitReader &Src, int64 CountBits)

CORE_API void	SetData (uint8 *Src, int64 CountBits)

CORE_API void	SetData (TArray< uint8 > &&Src, int64 CountBits)

CORE_API void	ResetData (FBitReader &Src, int64 CountBits, int64 CountBitsWithSlack=0)

PGO_LINK_DISABLE_WARNINGS void	SerializeBits (void *Dest, int64 LengthBits)

PGO_LINK_ENABLE_WARNINGS virtual CORE_API void	SerializeBitsWithOffset (void *Dest, int32 DestBit, int64 LengthBits) override

void	SerializeInt (uint32 &OutValue, uint32 ValueMax)

virtual CORE_API void	SerializeIntPacked (uint32 &Value) override

uint32	ReadInt (uint32 Max)

uint8	ReadBit ()

UE_FORCEINLINE_HINT void	Serialize (void *Dest, int64 LengthBytes)

UE_FORCEINLINE_HINT uint8 *	GetData ()

UE_FORCEINLINE_HINT const uint8 *	GetData () const

UE_FORCEINLINE_HINT const TArray< uint8 > &	GetBuffer () const

uint8 *	GetDataPosChecked ()

UE_FORCEINLINE_HINT int64	GetBytesLeft () const

UE_FORCEINLINE_HINT int64	GetBitsLeft () const

UE_FORCEINLINE_HINT bool	AtEnd ()

UE_FORCEINLINE_HINT int64	GetNumBytes () const

UE_FORCEINLINE_HINT int64	GetNumBits () const

UE_FORCEINLINE_HINT int64	GetPosBits () const

void	EatByteAlign ()

void	Skip (int32 BitCount)

CORE_API void	SetOverflowed (int64 LengthBits)

void	SetAtEnd ()

CORE_API void	AppendDataFromChecked (FBitReader &Src)

CORE_API void	AppendDataFromChecked (uint8 *Src, uint32 NumBits)

CORE_API void	AppendTo (TArray< uint8 > &Buffer)

Public Member Functions inherited from FBitArchive
CORE_API	FBitArchive ()

Public Member Functions inherited from FArchive
	FArchive ()=default

	FArchive (const FArchive &)=default

FArchive &	operator= (const FArchive &ArchiveToCopy)=default

virtual CORE_API	~FArchive ()

virtual CORE_API FArchive &	operator<< (FText &Value)

virtual FArchive &	operator<< (FField *&Value)

template<class T >
FArchive &	operator<< (TCheckedObjPtr< T > &Value)

virtual CORE_API FArchive &	operator<< (struct FLazyObjectPtr &Value)

virtual void	ForceBlueprintFinalization ()

virtual CORE_API void	SerializeIntPacked64 (uint64 &Value)

virtual void	Preload (UObject *Object)

FArchiveState &	GetArchiveState ()

const FArchiveState &	GetArchiveState () const

virtual void	Seek (int64 InPos)

virtual void	AttachBulkData (UObject Owner, FBulkData BulkData)

virtual void	AttachBulkData (UE::Serialization::FEditorBulkData *BulkData)

virtual void	DetachBulkData (FBulkData *BulkData, bool bEnsureBulkDataIsLoaded)

virtual void	DetachBulkData (UE::Serialization::FEditorBulkData *BulkData, bool bEnsureBulkDataIsLoaded)

virtual bool	SerializeBulkData (FBulkData &BulkData, const FBulkDataSerializationParams &Params)

virtual bool	IsProxyOf (FArchive *InOther) const

virtual bool	Precache (int64 PrecacheOffset, int64 PrecacheSize)

virtual void	FlushCache ()

virtual bool	SetCompressionMap (TArray< FCompressedChunk > *CompressedChunks, ECompressionFlags CompressionFlags)

virtual void	Flush ()

virtual bool	Close ()

CORE_API void	SerializeCompressed (void *V, int64 Length, FName CompressionFormatCannotChange, ECompressionFlags Flags=COMPRESS_NoFlags, bool bTreatBufferAsFileReader=false)

CORE_API void	SerializeCompressedNew (void V, int64 Length, FName CompressionFormatToEncode, FName CompressionFormatToDecodeOldV1Files, ECompressionFlags Flags=COMPRESS_NoFlags, bool bTreatBufferAsFileReader=false, int64 OutPartialReadLength=nullptr)

CORE_API void	SerializeCompressedNew (void *V, int64 Length)

CORE_API void	ByteSwap (void *V, int32 Length)

FArchive &	ByteOrderSerialize (void *V, int32 Length)

void	StartSerializingDefaults ()

void	StopSerializingDefaults ()

virtual void	MarkScriptSerializationStart (const UObject *Obj)

virtual void	MarkScriptSerializationEnd (const UObject *Obj)

virtual void	MarkSearchableName (const TObjectPtr< const UObject > &TypeObject, const FName &ValueName) const

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

virtual CORE_API void	UsingCustomVersion (const struct FGuid &Guid)

virtual FArchive *	GetCacheableArchive ()

void	SetCookData (FArchiveCookData *InCookData)

FArchiveCookData *	GetCookData ()

virtual CORE_API void	PushSerializedProperty (class FProperty *InProperty, const bool bIsEditorOnlyProperty)

virtual CORE_API void	PopSerializedProperty (class FProperty *InProperty, const bool bIsEditorOnlyProperty)

virtual bool	AttachExternalReadDependency (FExternalReadCallback &ReadCallback)

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

virtual void	PushFileRegionType (EFileRegionType Type)

virtual void	PopFileRegionType ()

CORE_API void	SetArchiveState (const FArchiveState &InState)

CORE_API void	SetError ()

CORE_API void	ClearError ()

CORE_API void	SetCriticalError ()

virtual FArchiveState &	GetInnermostState ()

virtual void	CountBytes (SIZE_T InNum, SIZE_T InMax)

virtual CORE_API FString	GetArchiveName () const

virtual FLinker *	GetLinker ()

virtual int64	Tell ()

virtual int64	TotalSize ()

bool	IsByteSwapping ()

void	ThisContainsCode ()

void	ThisContainsMap ()

CORE_API void	ThisRequiresLocalizationGather ()

virtual UObject *	GetArchetypeFromLoader (const UObject *Obj)

UE_FORCEINLINE_HINT FPackageFileVersion	UEVer () const

UE_FORCEINLINE_HINT int32	LicenseeUEVer () const

UE_FORCEINLINE_HINT FEngineVersionBase	EngineVer () const

virtual CORE_API uint32	EngineNetVer () const

virtual CORE_API uint32	GameNetVer () const

CORE_API int32	CustomVer (const struct FGuid &Key) const

UE_FORCEINLINE_HINT bool	IsLoading () const

UE_FORCEINLINE_HINT bool	IsLoadingFromCookedPackage () const

UE_FORCEINLINE_HINT bool	IsSaving () const

bool	IsTransacting () const

UE_FORCEINLINE_HINT bool	IsTextFormat () const

UE_FORCEINLINE_HINT bool	WantBinaryPropertySerialization () const

UE_FORCEINLINE_HINT bool	UseUnversionedPropertySerialization () const

UE_FORCEINLINE_HINT bool	IsForcingUnicode () const

UE_FORCEINLINE_HINT bool	IsPersistent () const

UE_FORCEINLINE_HINT bool	GetError () const

UE_FORCEINLINE_HINT bool	IsError () const

UE_FORCEINLINE_HINT bool	IsCriticalError () const

UE_FORCEINLINE_HINT bool	ContainsCode () const

UE_FORCEINLINE_HINT bool	ContainsMap () const

bool	RequiresLocalizationGather () const

UE_FORCEINLINE_HINT bool	ForceByteSwapping () const

UE_FORCEINLINE_HINT bool	IsSerializingDefaults () const

UE_FORCEINLINE_HINT bool	IsIgnoringArchetypeRef () const

UE_FORCEINLINE_HINT bool	DoDelta () const

UE_FORCEINLINE_HINT bool	DoIntraPropertyDelta () const

UE_FORCEINLINE_HINT bool	IsIgnoringOuterRef () const

UE_FORCEINLINE_HINT bool	IsIgnoringClassGeneratedByRef () const

UE_FORCEINLINE_HINT bool	IsIgnoringClassRef () const

UE_FORCEINLINE_HINT bool	IsAllowingLazyLoading () const

UE_FORCEINLINE_HINT bool	IsObjectReferenceCollector () const

UE_FORCEINLINE_HINT bool	IsModifyingWeakAndStrongReferences () const

UE_FORCEINLINE_HINT bool	IsCountingMemory () const

UE_FORCEINLINE_HINT uint32	GetPortFlags () const

UE_FORCEINLINE_HINT bool	HasAnyPortFlags (uint32 Flags) const

UE_FORCEINLINE_HINT bool	HasAllPortFlags (uint32 Flags) const

uint32	GetDebugSerializationFlags () const

UE_FORCEINLINE_HINT bool	ShouldSkipBulkData () const

UE_FORCEINLINE_HINT int64	GetMaxSerializeSize () const

virtual CORE_API const FCustomVersionContainer &	GetCustomVersions () const

virtual CORE_API void	SetCustomVersions (const FCustomVersionContainer &CustomVersionContainer)

virtual CORE_API void	ResetCustomVersions ()

CORE_API void	SetCustomVersion (const struct FGuid &Key, int32 Version, FName FriendlyName)

void	SetByteSwapping (bool Enabled)

void	SetPortFlags (uint32 InPortFlags)

virtual void	SetDebugSerializationFlags (uint32 InCustomFlags)

bool	IsFilterEditorOnly () const

virtual void	SetFilterEditorOnly (bool InFilterEditorOnly)

bool	IsSavingOptionalObject () const

virtual void	SetSavingOptionalObject (bool InSavingOptionalObject)

bool	IsSaveGame () const

UE_FORCEINLINE_HINT bool	IsNetArchive () const

UE_FORCEINLINE_HINT bool	IsCooking () const

UE_FORCEINLINE_HINT const ITargetPlatform *	CookingTarget () const

void	SetSavePackageData (FArchiveSavePackageData *InSavePackageData)

FArchiveSavePackageData *	GetSavePackageData ()

UE_FORCEINLINE_HINT FArchiveCookContext *	GetCookContext ()

virtual bool	UseToResolveEnumerators () const

virtual bool	ShouldSkipProperty (const FProperty *InProperty) const

virtual void	SetSerializedProperty (FProperty *InProperty)

UE_FORCEINLINE_HINT class FProperty *	GetSerializedProperty () const

CORE_API void	GetSerializedPropertyChain (TArray< class FProperty * > &OutProperties) const

UE_FORCEINLINE_HINT const FArchiveSerializedPropertyChain *	GetSerializedPropertyChain () const

virtual CORE_API void	SetSerializedPropertyChain (const FArchiveSerializedPropertyChain InSerializedPropertyChain, class FProperty InSerializedPropertyOverride=nullptr)

virtual void	SetSerializeContext (FUObjectSerializeContext *InLoadContext)

virtual CORE_API void	Reset ()

virtual CORE_API void	SetIsLoading (bool bInIsLoading)

virtual CORE_API void	SetIsLoadingFromCookedPackage (bool bInIsLoadingFromCookedPackage)

virtual CORE_API void	SetIsSaving (bool bInIsSaving)

virtual CORE_API void	SetIsTransacting (bool bInIsTransacting)

virtual CORE_API void	SetIsTextFormat (bool bInIsTextFormat)

virtual CORE_API void	SetWantBinaryPropertySerialization (bool bInWantBinaryPropertySerialization)

virtual CORE_API void	SetUseUnversionedPropertySerialization (bool bInUseUnversioned)

virtual CORE_API void	SetForceUnicode (bool bInForceUnicode)

virtual CORE_API void	SetIsPersistent (bool bInIsPersistent)

virtual CORE_API void	SetUEVer (FPackageFileVersion InVer)

virtual CORE_API void	SetLicenseeUEVer (int32 InVer)

virtual CORE_API void	SetEngineVer (const FEngineVersionBase &InVer)

virtual CORE_API void	SetEngineNetVer (const uint32 InEngineNetVer)

virtual CORE_API void	SetGameNetVer (const uint32 InGameNetVer)

UE_FORCEINLINE_HINT bool	ShouldSkipCompilingAssets () const

CORE_API void	SetShouldSkipUpdateCustomVersion (bool bShouldSkip)

UE_FORCEINLINE_HINT bool	ShouldSkipUpdateCustomVersion () const

CORE_API void	SetMigratingRemoteObjects (bool bMigrating)

UE_FORCEINLINE_HINT constexpr bool	IsMigratingRemoteObjects () const

virtual const FUObjectMigrationContext *	GetMigrationContext () const

Public Attributes
UPackageMap *	PackageMap = nullptr

TPimplPtr< UE::Net::FNetResult, EPimplPtrMode::DeepCopy >	ExtendedError

Public Attributes inherited from FArchive
FFastPathLoadBuffer *	ActiveFPLB

FFastPathLoadBuffer	InlineFPLB

uint8	ArContainsCode: 1

uint8	ArContainsMap: 1

UE_DEPRECATED(5.6, "Public access to ArRequiresLocalizationGather has been deprecated - please use Ar.RequiresLocalizationGather() and Ar.ThisRequiresLocalizationGather() for getting and setting respectively.") uint8 ArRequiresLocalizationGather uint8	ArForceByteSwapping: 1

uint8	ArIgnoreArchetypeRef: 1

uint8	ArNoDelta: 1

uint8	ArNoIntraPropertyDelta: 1

uint8	ArIgnoreOuterRef: 1

uint8	ArIgnoreClassGeneratedByRef: 1

uint8	ArIgnoreClassRef: 1

uint8	ArAllowLazyLoading: 1

uint8	ArIsObjectReferenceCollector: 1

uint8	ArIsModifyingWeakAndStrongReferences: 1

uint8	ArIsCountingMemory: 1

uint8	ArShouldSkipBulkData: 1

uint8	ArIsFilterEditorOnly: 1

uint8	ArIsSavingOptionalObject: 1

uint8	ArIsSaveGame: 1

uint8	ArIsNetArchive: 1

uint8	ArUseCustomPropertyList: 1

int32	ArSerializingDefaults

uint32	ArPortFlags

int64	ArMaxSerializeSize

uint8	ArMergeOverrides: 1

uint8	ArPreserveArrayElements: 1

const struct FCustomPropertyListNode *	ArCustomPropertyList

Additional Inherited Members
Protected Member Functions inherited from FBitReader
CORE_API void	SetNetVersionsFromArchive (FArchive &Source)

Protected Member Functions inherited from FArchive
void	SetShouldSkipCompilingAssets (bool Enabled)

Static Protected Member Functions inherited from FArchive
static CORE_API void	LinkProxy (FArchiveState &Inner, FArchiveState &Proxy)

static CORE_API void	UnlinkProxy (FArchiveState &Inner, FArchiveState &Proxy)

Protected Attributes inherited from FBitReader
TArray< uint8 >	Buffer

int64	Num

int64	Pos

Detailed Description

FNetBitReader A bit reader that serializes FNames and UObject* through a network packagemap.

Constructor & Destructor Documentation

◆ FNetBitReader() [1/3]

FNetBitReader::FNetBitReader	(	UPackageMap *	InPackageMap = `nullptr`,
		const uint8 *	Src = `nullptr`,
		int64	CountBits = `0`
	)

◆ FNetBitReader() [2/3]

FNetBitReader::FNetBitReader ( const FNetBitReader & )

default

◆ FNetBitReader() [3/3]

FNetBitReader::FNetBitReader ( FNetBitReader && )

default

◆ ~FNetBitReader()

FNetBitReader::~FNetBitReader ( )

virtualdefault

Member Function Documentation

◆ CountMemory()

void FNetBitReader::CountMemory ( FArchive & Ar ) const

overridevirtual

Counts the in-memory bytes used by this object

Reimplemented from FBitReader.

Reimplemented in FInBunch.

◆ operator<<() [1/6]

FArchive & FNetBitReader::operator<< ( FName & Value )

overridevirtual

Serializes an FName value from or into this archive.

This operator can be implemented by sub-classes that wish to serialize FName instances.

Parameters

Value The value to serialize.

Returns: This instance.

Reimplemented from FArchive.

◆ operator<<() [2/6]

FArchive & FNetBitReader::operator<< ( FObjectPtr & Value )

overridevirtual

Serializes a wrapped object pointer value from or into this archive.

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

Parameters

Value The value to serialize.

Returns: This instance.

Reimplemented from FArchive.

◆ operator<<() [3/6]

FArchive & FNetBitReader::operator<< ( FSoftObjectPath & Value )

overridevirtual

Serializes soft object paths from or into this archive.

Parameters

Value Soft object path to serialize.

Returns: This instance.

Reimplemented from FArchive.

◆ operator<<() [4/6]

FArchive & FNetBitReader::operator<< ( FSoftObjectPtr & Value )

overridevirtual

Serializes asset pointer from or into this archive.

Most of the time, FSoftObjectPtr are serialized as UObject *, but some archives need to override this.

Parameters

Value The asset pointer to serialize.

Returns: This instance.

Reimplemented from FArchive.

◆ operator<<() [5/6]

FArchive & FNetBitReader::operator<< ( struct FWeakObjectPtr & Value )

overridevirtual

Serializes FWeakObjectPtr value from or into this archive.

This operator can be implemented by sub-classes that wish to serialize FWeakObjectPtr instances.

Parameters

Value The value to serialize.

Returns: This instance.

Reimplemented from FArchive.

◆ operator<<() [6/6]

FArchive & FNetBitReader::operator<< ( UObject *& Value )

overridevirtual

Serializes an UObject value from or into this archive.

This operator can be implemented by sub-classes that wish to serialize UObject instances.

Parameters

Value The value to serialize.

Returns: This instance.

Reimplemented from FArchive.

◆ operator=() [1/2]

FNetBitReader & FNetBitReader::operator= ( const FNetBitReader & )

default

◆ operator=() [2/2]

FNetBitReader & FNetBitReader::operator= ( FNetBitReader && )

default

Member Data Documentation

◆ ExtendedError

TPimplPtr<UE::Net::FNetResult, EPimplPtrMode::DeepCopy> FNetBitReader::ExtendedError

Stores additional error information. Avoid using to modify control flow, where bunches with errors may be copied/cached/queued.

◆ PackageMap

UPackageMap* FNetBitReader::PackageMap = nullptr

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

Engine/Source/Runtime/CoreUObject/Public/UObject/CoreNet.h
Engine/Source/Runtime/CoreUObject/Private/UObject/CoreNet.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FNetBitReader() [1/3]

◆ FNetBitReader() [2/3]

◆ FNetBitReader() [3/3]

◆ ~FNetBitReader()

Member Function Documentation

◆ CountMemory()

◆ operator<<() [1/6]

◆ operator<<() [2/6]

◆ operator<<() [3/6]

◆ operator<<() [4/6]

◆ operator<<() [5/6]

◆ operator<<() [6/6]

◆ operator=() [1/2]

◆ operator=() [2/2]

Member Data Documentation

◆ ExtendedError

◆ PackageMap