FNetGUIDCache Class Reference

#include <PackageMapClient.h>

Public Types
enum class	ENetworkChecksumMode : uint8 { None = 0 , SaveAndUse = 1 , SaveButIgnore = 2 }
enum class	EAsyncLoadMode : uint8 { UseCVar = 0 , ForceDisable = 1 , ForceEnable = 2 }

Public Member Functions
ENGINE_API	FNetGUIDCache (UNetDriver *InDriver, uint64 NetworkGuidSeed=0)
virtual	~FNetGUIDCache ()
PRAGMA_DISABLE_DEPRECATION_WARNINGS	FNetGUIDCache (FNetGUIDCache &&)=default
	FNetGUIDCache (const FNetGUIDCache &)=delete
FNetGUIDCache &	operator= (FNetGUIDCache &&)=default
FNetGUIDCache &	operator= (const FNetGUIDCache &)=delete
ENGINE_API void	CleanReferences ()
ENGINE_API bool	SupportsObject (const UObject *Object, const TWeakObjectPtr< UObject > *WeakObjectPtr=nullptr) const
ENGINE_API bool	IsDynamicObject (const UObject *Object)
virtual ENGINE_API bool	IsNetGUIDAuthority () const
ENGINE_API FNetworkGUID	GetOrAssignNetGUID (UObject *Object, const TWeakObjectPtr< UObject > *WeakObjectPtr=nullptr)
ENGINE_API FNetworkGUID	GetNetGUID (const UObject *Object) const
ENGINE_API FNetworkGUID	GetOuterNetGUID (const FNetworkGUID &NetGUID) const
virtual ENGINE_API FNetworkGUID	AssignNewNetGUID_Server (UObject *Object)
virtual ENGINE_API FNetworkGUID	AssignNewNetGUIDFromPath_Server (const FString &PathName, UObject *ObjOuter, UClass *ObjClass)
ENGINE_API void	RegisterNetGUID_Internal (const FNetworkGUID &NetGUID, const FNetGuidCacheObject &CacheObject)
ENGINE_API void	RegisterNetGUID_Server (const FNetworkGUID &NetGUID, UObject *Object)
ENGINE_API void	RegisterNetGUID_Client (const FNetworkGUID &NetGUID, const UObject *Object)
ENGINE_API void	RegisterNetGUIDFromPath_Client (const FNetworkGUID &NetGUID, const FString &PathName, const FNetworkGUID &OuterGUID, const uint32 NetworkChecksum, const bool bNoLoad, const bool bIgnoreWhenMissing)
ENGINE_API void	RegisterNetGUIDFromPath_Server (const FNetworkGUID &NetGUID, const FString &PathName, const FNetworkGUID &OuterGUID, const uint32 NetworkChecksum, const bool bNoLoad, const bool bIgnoreWhenMissing)
ENGINE_API UObject *	GetObjectFromNetGUID (const FNetworkGUID &NetGUID, const bool bIgnoreMustBeMapped)
ENGINE_API bool	ShouldIgnoreWhenMissing (const FNetworkGUID &NetGUID) const
ENGINE_API FNetGuidCacheObject const *const	GetCacheObject (const FNetworkGUID &NetGUID) const
ENGINE_API bool	IsGUIDRegistered (const FNetworkGUID &NetGUID) const
ENGINE_API bool	IsGUIDLoaded (const FNetworkGUID &NetGUID) const
ENGINE_API bool	IsGUIDBroken (const FNetworkGUID &NetGUID, const bool bMustBeRegistered) const
ENGINE_API bool	IsGUIDNoLoad (const FNetworkGUID &NetGUID) const
ENGINE_API bool	IsGUIDPending (const FNetworkGUID &NetGUID) const
ENGINE_API FString	FullNetGUIDPath (const FNetworkGUID &NetGUID) const
ENGINE_API void	GenerateFullNetGUIDPath_r (const FNetworkGUID &NetGUID, FString &FullPath) const
ENGINE_API uint32	GetClassNetworkChecksum (UClass *Class)
ENGINE_API uint32	GetNetworkChecksum (UObject *Obj)
ENGINE_API void	SetNetworkChecksumMode (const ENetworkChecksumMode NewMode)
ENGINE_API void	SetAsyncLoadMode (const EAsyncLoadMode NewMode)
ENGINE_API bool	ShouldAsyncLoad () const
ENGINE_API bool	CanClientLoadObject (const UObject *Object, const FNetworkGUID &NetGUID) const
ENGINE_API FString	Describe (const FNetworkGUID &NetGUID) const
ENGINE_API bool	RemoveNetGUID (const UObject *Object)
ENGINE_API void	RemoveActorNetGUIDs (const AActor *Actor)
ENGINE_API void	AsyncPackageCallback (const FName &PackageName, UPackage *Package, EAsyncLoadingResult::Type Result)
ENGINE_API void	ResetCacheForDemo ()
ENGINE_API void	CountBytes (FArchive &Ar) const
ENGINE_API void	ConsumeAsyncLoadDelinquencyAnalytics (FNetAsyncLoadDelinquencyAnalytics &Out)
ENGINE_API const FNetAsyncLoadDelinquencyAnalytics &	GetAsyncLoadDelinquencyAnalytics () const
ENGINE_API void	ResetAsyncLoadDelinquencyAnalytics ()
ENGINE_API void	CollectReferences (class FReferenceCollector &ReferenceCollector)
ENGINE_API TSharedRef< FQueuedBunchObjectReference >	TrackQueuedBunchObjectReference (const FNetworkGUID InNetGUID, UObject *InObject)
bool	WasGUIDSyncLoaded (FNetworkGUID NetGUID) const
void	ClearSyncLoadedGUID (FNetworkGUID NetGUID)
ENGINE_API void	ReportSyncLoadedGUIDs ()
ENGINE_API void	ResetReplayDirtyTracking ()
ENGINE_API const TArray< FNetworkGUID > *	FindUnmappedStablyNamedGuidsWithOuter (FNetworkGUID OuterGUID) const
const void	RemoveUnmappedStablyNamedGuidsWithOuter (FNetworkGUID OuterGUID)

Static Public Member Functions
static ENGINE_API const bool	IsHistoryEnabled ()

Public Attributes
TMap< FNetworkGUID, FNetGuidCacheObject >	ObjectLookup
TMap< TWeakObjectPtr< UObject >, FNetworkGUID >	NetGUIDLookup
int32	UniqueNetIDs [2]
TSet< FNetworkGUID >	ImportedNetGuids
TMap< FNetworkGUID, TSet< FNetworkGUID > >	PendingOuterNetGuids
UNetDriver *	Driver
ENetworkChecksumMode	NetworkChecksumMode
EAsyncLoadMode	AsyncLoadMode
bool	IsExportingNetGUIDBunch
TMap< FNetworkGUID, FString >	History

Friends
class	UPackageMapClient

Member Enumeration Documentation

EAsyncLoadMode

enum class FNetGUIDCache::EAsyncLoadMode : uint8

strong

Enumerator
UseCVar
ForceDisable
ForceEnable

ENetworkChecksumMode

enum class FNetGUIDCache::ENetworkChecksumMode : uint8

strong

Enumerator
None
SaveAndUse
SaveButIgnore

Constructor & Destructor Documentation

FNetGUIDCache() [1/3]

FNetGUIDCache::FNetGUIDCache	(	UNetDriver *	InDriver,
		uint64	NetworkGuidSeed = 0
	)

~FNetGUIDCache()

virtual FNetGUIDCache::~FNetGUIDCache ( )

inlinevirtual

FNetGUIDCache() [2/3]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FNetGUIDCache::FNetGUIDCache ( FNetGUIDCache &&  )

default

FNetGUIDCache() [3/3]

FNetGUIDCache::FNetGUIDCache ( const FNetGUIDCache &  )

delete

Member Function Documentation

AssignNewNetGUID_Server()

FNetworkGUID FNetGUIDCache::AssignNewNetGUID_Server ( UObject *  Object )

virtual

Generate a new NetGUID for this object and assign it.

AssignNewNetGUIDFromPath_Server()

FNetworkGUID FNetGUIDCache::AssignNewNetGUIDFromPath_Server ( const FString &  PathName, UObject *  ObjOuter, UClass *  ObjClass  )

virtual

AsyncPackageCallback()

void FNetGUIDCache::AsyncPackageCallback	(	const FName &	PackageName,
		UPackage *	Package,
		EAsyncLoadingResult::Type	Result
	)

CanClientLoadObject()

bool FNetGUIDCache::CanClientLoadObject	(	const UObject *	Object,
		const FNetworkGUID &	NetGUID
	)		const

CleanReferences()

void FNetGUIDCache::CleanReferences

(

)

ClearSyncLoadedGUID()

void FNetGUIDCache::ClearSyncLoadedGUID ( FNetworkGUID  NetGUID )

inline

CollectReferences()

void FNetGUIDCache::CollectReferences

(

class FReferenceCollector &

ReferenceCollector

)

ConsumeAsyncLoadDelinquencyAnalytics()

void FNetGUIDCache::ConsumeAsyncLoadDelinquencyAnalytics

(

FNetAsyncLoadDelinquencyAnalytics &

Out

)

CountBytes()

void FNetGUIDCache::CountBytes

(

FArchive &

Ar

)

const

Describe()

FString FNetGUIDCache::Describe

(

const FNetworkGUID &

NetGUID

)

const

FindUnmappedStablyNamedGuidsWithOuter()

const TArray< FNetworkGUID > * FNetGUIDCache::FindUnmappedStablyNamedGuidsWithOuter

(

FNetworkGUID

OuterGUID

)

const

FullNetGUIDPath()

FString FNetGUIDCache::FullNetGUIDPath

(

const FNetworkGUID &

NetGUID

)

const

GenerateFullNetGUIDPath_r()

void FNetGUIDCache::GenerateFullNetGUIDPath_r	(	const FNetworkGUID &	NetGUID,
		FString &	FullPath
	)		const

GetAsyncLoadDelinquencyAnalytics()

const FNetAsyncLoadDelinquencyAnalytics & FNetGUIDCache::GetAsyncLoadDelinquencyAnalytics

(

)

const

GetCacheObject()

FNetGuidCacheObject const *const FNetGUIDCache::GetCacheObject

(

const FNetworkGUID &

NetGUID

)

const

GetClassNetworkChecksum()

uint32 FNetGUIDCache::GetClassNetworkChecksum

(

UClass *

Class

)

GetNetGUID()

FNetworkGUID FNetGUIDCache::GetNetGUID

(

const UObject *

Object

)

const

GetNetworkChecksum()

uint32 FNetGUIDCache::GetNetworkChecksum

(

UObject *

Obj

)

GetObjectFromNetGUID()

UObject * FNetGUIDCache::GetObjectFromNetGUID	(	const FNetworkGUID &	NetGUID,
		const bool	bIgnoreMustBeMapped
	)

GetOrAssignNetGUID()

FNetworkGUID FNetGUIDCache::GetOrAssignNetGUID	(	UObject *	Object,
		const TWeakObjectPtr< UObject > *	WeakObjectPtr = nullptr
	)

Gets or assigns a new NetGUID to this object. Returns whether the object is fully mapped or not

Parameters

WeakObjectPtr

Optional: pass in existing weakptr to prevent this function from constructing one internally

GetOuterNetGUID()

FNetworkGUID FNetGUIDCache::GetOuterNetGUID

(

const FNetworkGUID &

NetGUID

)

const

IsDynamicObject()

bool FNetGUIDCache::IsDynamicObject

(

const UObject *

Object

)

Dynamic objects are actors or sub-objects that were spawned in the world at run time, and therefor cannot be referenced with a path name to the client.

IsGUIDBroken()

bool FNetGUIDCache::IsGUIDBroken	(	const FNetworkGUID &	NetGUID,
		const bool	bMustBeRegistered
	)		const

IsGUIDLoaded()

bool FNetGUIDCache::IsGUIDLoaded

(

const FNetworkGUID &

NetGUID

)

const

IsGUIDNoLoad()

bool FNetGUIDCache::IsGUIDNoLoad

(

const FNetworkGUID &

NetGUID

)

const

IsGUIDPending()

bool FNetGUIDCache::IsGUIDPending

(

const FNetworkGUID &

NetGUID

)

const

IsGUIDRegistered()

bool FNetGUIDCache::IsGUIDRegistered

(

const FNetworkGUID &

NetGUID

)

const

IsHistoryEnabled()

const bool FNetGUIDCache::IsHistoryEnabled ( )

static

IsNetGUIDAuthority()

bool FNetGUIDCache::IsNetGUIDAuthority ( ) const

virtual

operator=() [1/2]

FNetGUIDCache & FNetGUIDCache::operator= ( const FNetGUIDCache &  )

delete

operator=() [2/2]

FNetGUIDCache & FNetGUIDCache::operator= ( FNetGUIDCache &&  )

default

RegisterNetGUID_Client()

void FNetGUIDCache::RegisterNetGUID_Client	(	const FNetworkGUID &	NetGUID,
		const UObject *	Object
	)

Associates a net guid directly with an object This function is only called on clients with dynamic guids

RegisterNetGUID_Internal()

void FNetGUIDCache::RegisterNetGUID_Internal	(	const FNetworkGUID &	NetGUID,
		const FNetGuidCacheObject &	CacheObject
	)

RegisterNetGUID_Server()

void FNetGUIDCache::RegisterNetGUID_Server	(	const FNetworkGUID &	NetGUID,
		UObject *	Object
	)

Associates a net guid directly with an object This function is only called on server

RegisterNetGUIDFromPath_Client()

void FNetGUIDCache::RegisterNetGUIDFromPath_Client	(	const FNetworkGUID &	NetGUID,
		const FString &	PathName,
		const FNetworkGUID &	OuterGUID,
		const uint32	NetworkChecksum,
		const bool	bNoLoad,
		const bool	bIgnoreWhenMissing
	)

Associates a net guid with a path, that can be loaded or found later This function is only called on the client

RegisterNetGUIDFromPath_Server()

void FNetGUIDCache::RegisterNetGUIDFromPath_Server	(	const FNetworkGUID &	NetGUID,
		const FString &	PathName,
		const FNetworkGUID &	OuterGUID,
		const uint32	NetworkChecksum,
		const bool	bNoLoad,
		const bool	bIgnoreWhenMissing
	)

Associates a net guid with a path, that can be loaded or found later This function is only called on the server

RemoveActorNetGUIDs()

void FNetGUIDCache::RemoveActorNetGUIDs

(

const AActor *

Actor

)

Remove an actor, it's components and all sub-object NetGUIDs from the NetGUID cache.

RemoveNetGUID()

bool FNetGUIDCache::RemoveNetGUID

(

const UObject *

Object

)

RemoveUnmappedStablyNamedGuidsWithOuter()

const void FNetGUIDCache::RemoveUnmappedStablyNamedGuidsWithOuter ( FNetworkGUID  OuterGUID )

inline

ReportSyncLoadedGUIDs()

void FNetGUIDCache::ReportSyncLoadedGUIDs

(

)

If LogNetSyncLoads is enabled, log all objects that caused a sync load that haven't been otherwise reported by the package map yet, and clear that list.

ResetAsyncLoadDelinquencyAnalytics()

void FNetGUIDCache::ResetAsyncLoadDelinquencyAnalytics

(

)

ResetCacheForDemo()

void FNetGUIDCache::ResetCacheForDemo

(

)

ResetReplayDirtyTracking()

void FNetGUIDCache::ResetReplayDirtyTracking

(

)

SetAsyncLoadMode()

void FNetGUIDCache::SetAsyncLoadMode

(

const EAsyncLoadMode

NewMode

)

SetNetworkChecksumMode()

void FNetGUIDCache::SetNetworkChecksumMode

(

const ENetworkChecksumMode

NewMode

)

ShouldAsyncLoad()

bool FNetGUIDCache::ShouldAsyncLoad

(

)

const

ShouldIgnoreWhenMissing()

bool FNetGUIDCache::ShouldIgnoreWhenMissing

(

const FNetworkGUID &

NetGUID

)

const

SupportsObject()

bool FNetGUIDCache::SupportsObject	(	const UObject *	Object,
		const TWeakObjectPtr< UObject > *	WeakObjectPtr = nullptr
	)		const

Parameters

WeakObjectPtr

Optional: pass in existing weakptr to prevent this function from constructing one internally

TrackQueuedBunchObjectReference()

TSharedRef< FQueuedBunchObjectReference > FNetGUIDCache::TrackQueuedBunchObjectReference	(	const FNetworkGUID	InNetGUID,
		UObject *	InObject
	)

WasGUIDSyncLoaded()

bool FNetGUIDCache::WasGUIDSyncLoaded ( FNetworkGUID  NetGUID ) const

inline

Friends And Related Symbol Documentation

UPackageMapClient

friend class UPackageMapClient

friend

Member Data Documentation

AsyncLoadMode

EAsyncLoadMode FNetGUIDCache::AsyncLoadMode

Driver

UNetDriver* FNetGUIDCache::Driver

History

TMap<FNetworkGUID, FString> FNetGUIDCache::History

ImportedNetGuids

TSet< FNetworkGUID > FNetGUIDCache::ImportedNetGuids

IsExportingNetGUIDBunch

bool FNetGUIDCache::IsExportingNetGUIDBunch

NetGUIDLookup

TMap< TWeakObjectPtr< UObject >, FNetworkGUID > FNetGUIDCache::NetGUIDLookup

NetworkChecksumMode

ENetworkChecksumMode FNetGUIDCache::NetworkChecksumMode

ObjectLookup

TMap< FNetworkGUID, FNetGuidCacheObject > FNetGUIDCache::ObjectLookup

PendingOuterNetGuids

TMap< FNetworkGUID, TSet< FNetworkGUID > > FNetGUIDCache::PendingOuterNetGuids

UniqueNetIDs

int32 FNetGUIDCache::UniqueNetIDs[2]

---

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

• Engine/Source/Runtime/Engine/Classes/Engine/PackageMapClient.h
• Engine/Source/Runtime/Engine/Private/PackageMapClient.cpp