FChunkDownloader | Unreal Engine 5.0 Documentation

API > API/Plugins > API/Plugins/ChunkDownloader

Inheritance Hierarchy

TSharedFromThis
FChunkDownloader

References


Module	ChunkDownloader
Header	/Engine/Plugins/Runtime/ChunkDownloader/Source/Public/ChunkDownloader.h
Include	#include "ChunkDownloader.h"

Syntax

class FChunkDownloader : public TSharedFromThis< FChunkDownloader >

Variables

	Type	Name	Description
	FPlatformChunkInstallMultiDelegate	OnChunkMounted	Called whenever a chunk mounts (success or failure). ONLY USE THIS IF YOU WANT TO PASSIVELY LISTEN FOR MOUNTS (otherwise use the proper request callback on MountChunk)
	TFunction< void(const FString &FileName, const FString &Url, uint64 SizeBytes, const FTimespan &Down...	OnDownloadAnalytics	Called each time a download attempt finishes (success or failure). ONLY USE THIS IF YOU WANT TO PASSIVELY LISTEN. Downloads retry until successful.

Constructors

	Type	Name	Description
		FChunkDownloader ()

Destructors

	Type	Name	Description
		~FChunkDownloader ()

Functions

Type	Name	Description
void	BeginLoadingMode ( const FCallback& Callback )	Snapshot stats and enter into loading screen mode (pauses all background downloads).
bool	CheckFileSha1Hash ( const FString& FullPathOnDisk, const FString& Sha1HashStr )
const TCHAR *	ChunkStatusToString ( EChunkStatus Status )	Chunk status as logable string
void	DownloadChunk ( int32 ChunkId, const FCallback& Callback, int32 Priority )	Download all pak files in the chunk, but don't mount.
void	DownloadChunks ( const TArray< int32 >& ChunkIds, const FCallback& Callback, int32 Priority )	Download (Cache) all pak files in these chunks then fire the callback (convenience wrapper managing multiple DownloadChunk calls)
void	DumpLoadedChunks ()
void	Finalize ()	Unmount all chunks and cancel any downloads in progress (preserving partial downloads).
int	FlushCache ()	Flush any cached files (on disk) that are not currently being downloaded to or mounting (does not unmount the corresponding pak files).
TSharedPtr< FChunkDownloader >	Get ()	Static getters
void	GetAllChunkIds ( TArray< int32 >& OutChunkIds )	Return a list of all chunk IDs in the current manifest
TSharedRef< FChunkDownloader >	GetChecked ()	Static getters
EChunkStatus	GetChunkStatus ( int32 ChunkId )	Get the current status of the specified chunk
const FString &	GetContentBuildId ()	Get the current content build ID
const FString &	GetDeploymentName ()	Get the most recent deployment name
const FStats &	GetLoadingStats ()	Get the current loading stats (generally only useful if you're in loading mode see BeginLoadingMode)
int32	GetNumDownloadRequests ()	Get current number of download requests, so we know whether download is in progress. Downlading Requests will be removed from this array in it's FDownload::OnCompleted callback.
TSharedRef< FChunkDownloader >	GetOrCreate ()	Static getters
void	Initialize ( const FString& PlatformName, int32 TargetDownloadsInFlight )	Initialize the download manager (populates the list of cached pak files from disk). Call only once.
bool	LoadCachedBuild ( const FString& DeploymentName )	Try to load a cached build ID from disk (good to do before updating build so it can possibly no-op)
void	MountChunk ( int32 ChunkId, const FCallback& Callback )	Download all pak files, then asynchronously mount them in order (in order among themselves, async with game thread).
void	MountChunks ( const TArray< int32 >& ChunkIds, const FCallback& Callback )	Download and mount all chunks then fire the callback (convenience wrapper managing multiple MountChunk calls)
void	Shutdown ()
void	UpdateBuild ( const FString& DeploymentName, const FString& ContentBuildId, const FCallback& Callback )	Set the the content build id if the content build id has changed, we pull the new BuildManifest from CDN and load it.
int	ValidateCache ()	Validate all fully cached files (blocking) by attempting to read them and check their Version hash.