Navigation
API > API/Runtime > API/Runtime/Core
Generic implementation of chunk based install
| Name | FGenericPlatformChunkInstall |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformChunkInstall.h |
| Include Path | #include "GenericPlatform/GenericPlatformChunkInstall.h" |
Syntax
class FGenericPlatformChunkInstall : public IPlatformChunkInstall
Implements Interfaces
Derived Classes
Functions
Public
Overridden from IPlatformChunkInstall
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FDelegateHandle AddChunkInstallDelegate
(
FPlatformChunkInstallDelegate Delegate |
Request a delegate callback on chunk install completion or failure. Request may not be respected. | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual FDelegateHandle AddNamedChunkCompleteDelegate
(
FPlatformNamedChunkCompleteDelegate Delegate |
Request a delegate callback on named chunk install completion or failure. | GenericPlatform/GenericPlatformChunkInstall.h | |
| Initialize the platform chunk installer in the background. | GenericPlatform/GenericPlatformChunkInstall.h | ||
virtual bool DebugStartNextChunk () |
For platforms that support emulation of the Chunk install. | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual 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. | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual float GetChunkProgress
(
uint32 ChunkID, |
Get the current install progress of a chunk. | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual EChunkInstallSpeed::Type GetInstallSpeed() |
Inquire about the priority of chunk installation vs. game IO. | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual bool GetNamedChunkInstallationStatus
(
const FName NamedChunk, |
Get detailed installation status for the given named chunk | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual EChunkLocation::Type GetNamedChunkLocation
(
const FName NamedChunk |
Get the current location of the given named chunk | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual float GetNamedChunkProgress
(
const FName NamedChunk, |
Get the current install progress of the given named chunk. | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual TArray< FName > GetNamedChunksByType
(
ENamedChunkType NamedChunkType |
Get a list of all the named chunks of the given type | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual ENamedChunkType GetNamedChunkType
(
const FName NamedChunk |
Query the type of the given named chunk | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual EChunkLocation::Type GetPakchunkLocation
(
int32 PakchunkIndex |
Get the current location of a chunk with pakchunk index. | GenericPlatform/GenericPlatformChunkInstall.h | |
| Get the list of pak files in the given named chunk. | GenericPlatform/GenericPlatformChunkInstall.h | ||
virtual bool GetProgressReportingTypeSupported
(
EChunkProgressReportingType::Type ReportType |
Check if a given reporting type is supported. | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual bool InstallNamedChunk
(
const FName NamedChunk |
Install the given named chunk | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual bool InstallNamedChunks
(
const TArrayView< const FName >& NamedChunks |
Install the given set of named chunks | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual bool IsAvailable() |
Returns whether chunk installation is available (i.e. we are an installed packaged build etc) | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual bool IsNamedChunkForCurrentLocale
(
const FName NamedChunk |
Determine if the given named chunk is suitable for the current system locale | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual bool IsNamedChunkInProgress
(
const FName NamedChunk |
Check whether the give chunk is being installed | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual bool PrioritizeChunk
(
uint32 ChunkID, |
Hint to the installer that we would like to prioritize a specific chunk | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual bool PrioritizeNamedChunk
(
const FName NamedChunk, |
Hint to the installer that we would like to prioritize a specific chunk | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual bool PrioritizePakchunk
(
int32 PakchunkIndex, |
Hint to the installer that we would like to prioritize a specific chunk | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual void RemoveChunkInstallDelegate
(
FDelegateHandle Delegate |
Remove a delegate callback on chunk install completion. | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual void RemoveNamedChunkCompleteDelegate
(
FDelegateHandle Delegate |
Remove a delegate callback on named chunk install completion. | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual bool SetAutoPakMountingEnabled
(
bool bEnabled |
Set whether pak files are auto-mounted when they are installed (the default is that they are mounted) | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual bool SetInstallSpeed
(
EChunkInstallSpeed::Type InstallSpeed |
Specify the priority of chunk installation vs. game IO. | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual bool SupportsBundleSource() |
Returns whether this platform chunk installer implements all the API functions to support the platform chunk install bundle source | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual bool SupportsNamedChunkInstall() |
Check whether current platform supports chunk installation by name | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual bool UninstallNamedChunk
(
const FName NamedChunk |
Uninstall the given named chunk | GenericPlatform/GenericPlatformChunkInstall.h | |
virtual bool UninstallNamedChunks
(
const TArrayView< const FName >& NamedChunks |
Uninstall the given set of named chunks | GenericPlatform/GenericPlatformChunkInstall.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DoNamedChunkCompleteCallbacks
(
const FName NamedChunk, |
GenericPlatform/GenericPlatformChunkInstall.h | ||
void DoNamedChunkCompleteCallbacks
(
const TArrayView< const FName >& NamedChunks, |
GenericPlatform/GenericPlatformChunkInstall.h |
Overridden from IPlatformChunkInstall
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EChunkLocation::Type GetChunkLocation
(
uint32 ChunkID |
Get the current location of a chunk. | GenericPlatform/GenericPlatformChunkInstall.h |