UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FInBunch Class Reference

#include <DataBunch.h>

+ Inheritance diagram for FInBunch:

Public Member Functions

FString ToString ()
 
ENGINE_API FInBunch (UNetConnection *InConnection, uint8 *Src=NULL, int64 CountBits=0)
 
ENGINE_API FInBunch (FInBunch &InBunch, bool CopyBuffer)
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS FInBunch (FInBunch &&)=default
 
 FInBunch (const FInBunch &)=default
 
FInBunchoperator= (FInBunch &&)=default
 
FInBunchoperator= (const FInBunch &)=default
 
ENGINE_API virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS void CountMemory (FArchive &Ar) const override
 
virtual uint32 EngineNetVer () const override
 
virtual uint32 GameNetVer () const override
 
virtual void SetEngineNetVer (const uint32 InEngineNetVer) override
 
virtual void SetGameNetVer (const uint32 InGameNetVer) override
 
- Public Member Functions inherited from FNetBitReader
COREUOBJECT_API FNetBitReader (UPackageMap *InPackageMap=nullptr, const uint8 *Src=nullptr, int64 CountBits=0)
 
COREUOBJECT_API FNetBitReader (const FNetBitReader &)
 
COREUOBJECT_API FNetBitReaderoperator= (const FNetBitReader &)
 
COREUOBJECT_API FNetBitReader (FNetBitReader &&)
 
COREUOBJECT_API FNetBitReaderoperator= (FNetBitReader &&)
 
virtual COREUOBJECT_API ~FNetBitReader ()
 
virtual COREUOBJECT_API FArchiveoperator<< (FName &Name) override
 
virtual COREUOBJECT_API FArchiveoperator<< (UObject *&Object) override
 
virtual COREUOBJECT_API FArchiveoperator<< (FSoftObjectPath &Value) override
 
virtual COREUOBJECT_API FArchiveoperator<< (FSoftObjectPtr &Value) override
 
virtual COREUOBJECT_API FArchiveoperator<< (FObjectPtr &Value) override
 
virtual COREUOBJECT_API FArchiveoperator<< (struct FWeakObjectPtr &Value) 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 FBitReaderoperator= (const FBitReader &)
 
CORE_API FBitReader (FBitReader &&)
 
CORE_API FBitReaderoperator= (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 uint8GetData ()
 
UE_FORCEINLINE_HINT const uint8GetData () const
 
UE_FORCEINLINE_HINT const TArray< uint8 > & GetBuffer () const
 
uint8GetDataPosChecked ()
 
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
 
FArchiveoperator= (const FArchive &ArchiveToCopy)=default
 
virtual CORE_API ~FArchive ()
 
virtual CORE_API FArchiveoperator<< (FText &Value)
 
virtual FArchiveoperator<< (FField *&Value)
 
template<class T >
FArchiveoperator<< (TCheckedObjPtr< T > &Value)
 
virtual CORE_API FArchiveoperator<< (struct FLazyObjectPtr &Value)
 
virtual void ForceBlueprintFinalization ()
 
virtual CORE_API void SerializeIntPacked64 (uint64 &Value)
 
virtual void Preload (UObject *Object)
 
FArchiveStateGetArchiveState ()
 
const FArchiveStateGetArchiveState () 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)
 
FArchiveByteOrderSerialize (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 FArchiveGetCacheableArchive ()
 
void SetCookData (FArchiveCookData *InCookData)
 
FArchiveCookDataGetCookData ()
 
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 FArchiveStateGetInnermostState ()
 
virtual void CountBytes (SIZE_T InNum, SIZE_T InMax)
 
virtual CORE_API FString GetArchiveName () const
 
virtual FLinkerGetLinker ()
 
virtual int64 Tell ()
 
virtual int64 TotalSize ()
 
bool IsByteSwapping ()
 
void ThisContainsCode ()
 
void ThisContainsMap ()
 
CORE_API void ThisRequiresLocalizationGather ()
 
virtual UObjectGetArchetypeFromLoader (const UObject *Obj)
 
UE_FORCEINLINE_HINT FPackageFileVersion UEVer () const
 
UE_FORCEINLINE_HINT int32 LicenseeUEVer () const
 
UE_FORCEINLINE_HINT FEngineVersionBase EngineVer () 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 FCustomVersionContainerGetCustomVersions () 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 ITargetPlatformCookingTarget () const
 
void SetSavePackageData (FArchiveSavePackageData *InSavePackageData)
 
FArchiveSavePackageDataGetSavePackageData ()
 
UE_FORCEINLINE_HINT FArchiveCookContextGetCookContext ()
 
virtual bool UseToResolveEnumerators () const
 
virtual bool ShouldSkipProperty (const FProperty *InProperty) const
 
virtual void SetSerializedProperty (FProperty *InProperty)
 
UE_FORCEINLINE_HINT class FPropertyGetSerializedProperty () const
 
CORE_API void GetSerializedPropertyChain (TArray< class FProperty * > &OutProperties) const
 
UE_FORCEINLINE_HINT const FArchiveSerializedPropertyChainGetSerializedPropertyChain () 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)
 
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 FUObjectMigrationContextGetMigrationContext () const
 

Public Attributes

int32 PacketId
 
FInBunchNext
 
UNetConnectionConnection
 
int32 ChIndex
 
FName ChName
 
int32 ChSequence
 
uint8 bOpen:1
 
uint8 bClose:1
 
uint8 bIsReplicationPaused:1
 
uint8 bReliable:1
 
uint8 bPartial:1
 
uint8 bPartialInitial:1
 
uint8 bPartialFinal:1
 
uint8 bHasPackageMapExports:1
 
uint8 bHasMustBeMappedGUIDs:1
 
uint8 bPartialCustomExportsFinal:1
 
uint8 bIgnoreRPCs:1
 
EChannelCloseReason CloseReason
 
- Public Attributes inherited from FNetBitReader
UPackageMapPackageMap = nullptr
 
TPimplPtr< UE::Net::FNetResult, EPimplPtrMode::DeepCopyExtendedError
 
- Public Attributes inherited from FArchive
FFastPathLoadBufferActiveFPLB
 
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 FCustomPropertyListNodeArCustomPropertyList
 

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< uint8Buffer
 
int64 Num
 
int64 Pos
 

Constructor & Destructor Documentation

◆ FInBunch() [1/4]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FInBunch::FInBunch ( UNetConnection InConnection,
uint8 Src = NULL,
int64  CountBits = 0 
)

◆ FInBunch() [2/4]

FInBunch::FInBunch ( FInBunch InBunch,
bool  CopyBuffer 
)

Copy constructor but with optional parameter to not copy buffer

◆ FInBunch() [3/4]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FInBunch::FInBunch ( FInBunch &&  )
default

◆ FInBunch() [4/4]

FInBunch::FInBunch ( const FInBunch )
default

Member Function Documentation

◆ CountMemory()

PRAGMA_ENABLE_DEPRECATION_WARNINGS void FInBunch::CountMemory ( FArchive Ar) const
overridevirtual

Counts the in-memory bytes used by this object

Reimplemented from FNetBitReader.

◆ EngineNetVer()

uint32 FInBunch::EngineNetVer ( ) const
overridevirtual

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

Reimplemented from FArchive.

◆ GameNetVer()

uint32 FInBunch::GameNetVer ( ) const
overridevirtual

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

Reimplemented from FArchive.

◆ operator=() [1/2]

FInBunch & FInBunch::operator= ( const FInBunch )
default

◆ operator=() [2/2]

FInBunch & FInBunch::operator= ( FInBunch &&  )
default

◆ SetEngineNetVer()

void FInBunch::SetEngineNetVer ( const uint32  InEngineNetVer)
overridevirtual

Sets the archive engine network version.

Reimplemented from FArchive.

◆ SetGameNetVer()

void FInBunch::SetGameNetVer ( const uint32  InGameNetVer)
overridevirtual

Sets the archive game network version.

Reimplemented from FArchive.

◆ ToString()

FString FInBunch::ToString ( )
inline

Member Data Documentation

◆ bClose

uint8 FInBunch::bClose

◆ bHasMustBeMappedGUIDs

uint8 FInBunch::bHasMustBeMappedGUIDs

◆ bHasPackageMapExports

uint8 FInBunch::bHasPackageMapExports

◆ bIgnoreRPCs

uint8 FInBunch::bIgnoreRPCs

◆ bIsReplicationPaused

uint8 FInBunch::bIsReplicationPaused

◆ bOpen

uint8 FInBunch::bOpen

◆ bPartial

uint8 FInBunch::bPartial

◆ bPartialCustomExportsFinal

uint8 FInBunch::bPartialCustomExportsFinal

◆ bPartialFinal

uint8 FInBunch::bPartialFinal

◆ bPartialInitial

uint8 FInBunch::bPartialInitial

◆ bReliable

uint8 FInBunch::bReliable

◆ ChIndex

int32 FInBunch::ChIndex

◆ ChName

FName FInBunch::ChName

◆ ChSequence

int32 FInBunch::ChSequence

◆ CloseReason

EChannelCloseReason FInBunch::CloseReason

◆ Connection

UNetConnection* FInBunch::Connection

◆ Next

FInBunch* FInBunch::Next

◆ PacketId

int32 FInBunch::PacketId

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