Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > GenericPlatform > IPlatformChunkInstall

Light Theme

Dark Theme

IPlatformChunkInstall

Interface for platform specific chunk based install

Windows

MacOS

Linux

Inheritance Hierarchy

IPlatformChunkInstall

FGenericPlatformChunkInstall

	FHTTPChunkInstall
	FLauncherChunkInstaller

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformChunkInstall.h
Include	#include "GenericPlatform/GenericPlatformChunkInstall.h"

Syntax

class IPlatformChunkInstall

Remarks

Interface for platform specific chunk based install

Destructors

	Name	Description
	~IPlatformChunkInstall()	Virtual destructor

Functions

	Name	Description
FDelegateHan...	AddChunkInstallDelegate ( FPlatformChunkInstallDelegate Deleg... )	Request a delegate callback on chunk install completion or failure. Request may not be respected.
bool	DebugStartNextChunk()	For platforms that support emulation of the Chunk install.
void	ExternalNotifyChunkAvailable ( uint32 InChunkID )	Allow an external system to notify that a particular chunk ID has become available Initial use-case is for dynamically encrypted pak files to signal to the outside world that it has become available.
EChunkLocati...	GetChunkLocation ( uint32 ChunkID )	Get the current location of a chunk.
float	GetChunkProgress ( uint32 ChunkID, EChunkProgressReportingType::Type R... )	Get the current install progress of a chunk.
EChunkInstal...	GetInstallSpeed()	Inquire about the priority of chunk installation vs. game IO.
EChunkLocati...	GetPakchunkLocation ( int32 PakchunkIndex )	Get the current location of a chunk with pakchunk index.
bool	GetProgressReportingTypeSupported ( EChunkProgressReportingType::Type R... )	Check if a given reporting type is supported.
bool	InstallChunks ( const TArray< FCustomChunk >& Chun... )	Install chunks with Intelligent Delivery API
bool	IsChunkInstallationPending ( const TArray< FCustomChunk >& Chun... )	Check whether installation of chunks are pending
bool	PrioritizeChunk ( uint32 ChunkID, EChunkPriority::Type Priority )	Hint to the installer that we would like to prioritize a specific chunk
bool	PrioritizePakchunk ( int32 PakchunkIndex, EChunkPriority::Type Priority )	Hint to the installer that we would like to prioritize a specific chunk
void	RemoveChunkInstallDelegate ( FDelegateHandle Delegate )	Remove a delegate callback on chunk install completion.
bool	SetInstallSpeed ( EChunkInstallSpeed::Type InstallSpe... )	Specify the priority of chunk installation vs. game IO.
bool	SupportsIntelligentInstall()	Check whether current platform supports intelligent chunk installation
bool	UninstallChunks ( const TArray< FCustomChunk >& Chun... )	Uninstall chunks with Intelligent Delivery API

Deprecated Functions

		Name	Description
	void	RemoveChunkInstallDelgate ( uint32 ChunkID, FDelegateHandle Delegate )	Call RemoveChunkInstallDelegate instead
	FDelegateHan...	SetChunkInstallDelgate ( uint32 ChunkID, FPlatformChunkInstallCompleteDelega... )	Call AddChunkInstallDelegate instead, which is now bound for all chunk ids

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss