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

#include <DataBunch.h>

+ Inheritance diagram for FOutBunch:

Public Member Functions

void SetDebugString (FString DebugStr)
 
FString GetDebugString () const
 
ENGINE_API FOutBunch ()
 
ENGINE_API FOutBunch (int64 InMaxBits)
 
ENGINE_API FOutBunch (class UChannel *InChannel, bool bClose)
 
ENGINE_API FOutBunch (UPackageMap *PackageMap, int64 InMaxBits=1024)
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS FOutBunch (FOutBunch &&)=default
 
 FOutBunch (const FOutBunch &)=default
 
FOutBunchoperator= (FOutBunch &&)=default
 
FOutBunchoperator= (const FOutBunch &)=default
 
ENGINE_API virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS ~FOutBunch ()
 
FString ToString ()
 
virtual ENGINE_API void CountMemory (FArchive &Ar) const override
 
virtual ENGINE_API void Reset () override
 
- Public Member Functions inherited from FNetBitWriter
COREUOBJECT_API FNetBitWriter (UPackageMap *InPackageMap, int64 InMaxBits)
 
COREUOBJECT_API FNetBitWriter (int64 InMaxBits)
 
COREUOBJECT_API FNetBitWriter ()
 
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 FBitWriter
CORE_API FBitWriter ()
 
virtual CORE_API ~FBitWriter ()
 
CORE_API FBitWriter (int64 InMaxBits, bool AllowResize=false)
 
CORE_API FBitWriter (const FBitWriter &)
 
CORE_API FBitWriteroperator= (const FBitWriter &)
 
CORE_API FBitWriter (FBitWriter &&)
 
CORE_API FBitWriteroperator= (FBitWriter &&)
 
virtual CORE_API void SerializeBits (void *Src, int64 LengthBits) override
 
virtual CORE_API void SerializeBitsWithOffset (void *Src, int32 SourceBit, int64 LengthBits) override
 
virtual CORE_API void SerializeInt (uint32 &Value, uint32 Max) override
 
virtual CORE_API void SerializeIntPacked (uint32 &Value) override
 
CORE_API void WriteIntWrapped (uint32 Value, uint32 ValueMax)
 
CORE_API void WriteBit (uint8 In)
 
virtual CORE_API void Serialize (void *Src, int64 LengthBytes) override
 
uint8GetData (void)
 
const uint8GetData (void) const
 
const TArray< uint8 > * GetBuffer (void) const
 
void SetNumBits (int64 NumBits)
 
UE_FORCEINLINE_HINT int64 GetNumBytes (void) const
 
UE_FORCEINLINE_HINT int64 GetNumBits (void) const
 
UE_FORCEINLINE_HINT int64 GetMaxBits (void) const
 
CORE_API void SetOverflowed (int32 LengthBits)
 
UE_FORCEINLINE_HINT void SetAllowOverflow (bool bInAllow)
 
bool AllowAppend (int64 LengthBits)
 
UE_FORCEINLINE_HINT void SetAllowResize (bool NewResize)
 
UE_FORCEINLINE_HINT void WriteAlign ()
 
- 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 ()
 
virtual bool AtEnd ()
 
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
 
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 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 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 FUObjectMigrationContextGetMigrationContext () const
 

Public Attributes

FOutBunchNext
 
UChannelChannel
 
double Time
 
int32 ChIndex
 
FName ChName
 
int32 ChSequence
 
int32 PacketId
 
uint8 ReceivedAck:1
 
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 bOutWantsFullInitState:1
 
EChannelCloseReason CloseReason
 
TArray< FNetworkGUIDExportNetGUIDs
 
TArray< uint64NetFieldExports
 
TArray< UE::Net::FNetToken, TInlineAllocator< 4 > > NetTokensPendingExport
 
FString DebugString
 
- Public Attributes inherited from FNetBitWriter
class UPackageMapPackageMap
 
TNetDoNotCopyPtr< UE::Net::FNetTokenExportContextNetTokenExportContext
 
- 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 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)
 

Constructor & Destructor Documentation

◆ FOutBunch() [1/6]

FOutBunch::FOutBunch ( )

◆ FOutBunch() [2/6]

PRAGMA_ENABLE_DEPRECATION_WARNINGS FOutBunch::FOutBunch ( int64  InMaxBits)
explicit

◆ FOutBunch() [3/6]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FOutBunch::FOutBunch ( class UChannel InChannel,
bool  bClose 
)

◆ FOutBunch() [4/6]

FOutBunch::FOutBunch ( UPackageMap PackageMap,
int64  InMaxBits = 1024 
)

◆ FOutBunch() [5/6]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FOutBunch::FOutBunch ( FOutBunch &&  )
default

◆ FOutBunch() [6/6]

FOutBunch::FOutBunch ( const FOutBunch )
default

◆ ~FOutBunch()

FOutBunch::~FOutBunch ( )
virtual

Member Function Documentation

◆ CountMemory()

void FOutBunch::CountMemory ( FArchive Ar) const
overridevirtual

Counts the in-memory bytes used by this object

Reimplemented from FNetBitWriter.

◆ GetDebugString()

FString FOutBunch::GetDebugString ( ) const
inline

◆ operator=() [1/2]

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

◆ operator=() [2/2]

FOutBunch & FOutBunch::operator= ( FOutBunch &&  )
default

◆ Reset()

void FOutBunch::Reset ( void  )
overridevirtual

Resets the bit writer back to its initial state

Reimplemented from FBitWriter.

◆ SetDebugString()

void FOutBunch::SetDebugString ( FString  DebugStr)
inline

◆ ToString()

FString FOutBunch::ToString ( )
inline

Member Data Documentation

◆ bClose

uint8 FOutBunch::bClose

◆ bHasMustBeMappedGUIDs

uint8 FOutBunch::bHasMustBeMappedGUIDs

◆ bHasPackageMapExports

uint8 FOutBunch::bHasPackageMapExports

◆ bIsReplicationPaused

uint8 FOutBunch::bIsReplicationPaused

◆ bOpen

uint8 FOutBunch::bOpen

◆ bOutWantsFullInitState

uint8 FOutBunch::bOutWantsFullInitState

◆ bPartial

uint8 FOutBunch::bPartial

◆ bPartialCustomExportsFinal

uint8 FOutBunch::bPartialCustomExportsFinal

◆ bPartialFinal

uint8 FOutBunch::bPartialFinal

◆ bPartialInitial

uint8 FOutBunch::bPartialInitial

◆ bReliable

uint8 FOutBunch::bReliable

◆ Channel

UChannel* FOutBunch::Channel

◆ ChIndex

int32 FOutBunch::ChIndex

◆ ChName

FName FOutBunch::ChName

◆ ChSequence

int32 FOutBunch::ChSequence

◆ CloseReason

EChannelCloseReason FOutBunch::CloseReason

◆ DebugString

FString FOutBunch::DebugString

◆ ExportNetGUIDs

TArray< FNetworkGUID > FOutBunch::ExportNetGUIDs

◆ NetFieldExports

TArray< uint64 > FOutBunch::NetFieldExports

◆ NetTokensPendingExport

TArray<UE::Net::FNetToken, TInlineAllocator<4> > FOutBunch::NetTokensPendingExport

◆ Next

FOutBunch* FOutBunch::Next

◆ PacketId

int32 FOutBunch::PacketId

◆ ReceivedAck

uint8 FOutBunch::ReceivedAck

◆ Time

double FOutBunch::Time

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