1. Epic GamesDeveloper
  3. IPlatformChunkInstall

IPlatformChunkInstall

Interface for platform specific chunk based install

API > API/Runtime > API/Runtime/Core

Interface for platform specific chunk based install

   
Name IPlatformChunkInstall
Type class
Header File /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformChunkInstall.h
Include Path #include "GenericPlatform/GenericPlatformChunkInstall.h"

Syntax

class IPlatformChunkInstall

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IPlatformChunkInstall()

 Virtual destructor GenericPlatform/GenericPlatformChunkInstall.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FDelegateHandle AddChunkInstallDelegate ( FPlatformChunkInstallDelegate Delegate
)

 Request a delegate callback on chunk install completion or failure. Request may not be respected. GenericPlatform/GenericPlatformChunkInstall.h  

FDelegateHandle AddNamedChunkCompleteDelegate ( FPlatformNamedChunkCompleteDelegate Delegate
)

 Request a delegate callback on named chunk install completion or failure. GenericPlatform/GenericPlatformChunkInstall.h  

FDelegateHandle AddNamedChunkInstallDelegate ( FPlatformNamedChunkInstallDelegate Delegate
)

 Request a delegate callback on named chunk install completion or failure. GenericPlatform/GenericPlatformChunkInstall.h  

void AsyncInit ( TFunction< void(bool)> OnInitComplete
)

 Initialize the platform chunk installer in the background. GenericPlatform/GenericPlatformChunkInstall.h  
For platforms that support emulation of the Chunk install. GenericPlatform/GenericPlatformChunkInstall.h  

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  

float GetChunkProgress ( uint32 ChunkID,
EChunkProgressReportingType::Type ReportType
)

 Get the current install progress of a chunk. GenericPlatform/GenericPlatformChunkInstall.h  

EChunkInstallSpeed::Type GetInstallSpeed()

 Inquire about the priority of chunk installation vs. game IO. GenericPlatform/GenericPlatformChunkInstall.h  

bool GetNamedChunkInstallationStatus ( const FName NamedChunk,
FChunkInstallationStatusDetail& OutChunkStatusDetail
) const

 Get detailed installation status for the given named chunk GenericPlatform/GenericPlatformChunkInstall.h  

EChunkLocation::Type GetNamedChunkLocation ( const FName NamedChunk
)

 Get the current location of the given named chunk GenericPlatform/GenericPlatformChunkInstall.h  

float GetNamedChunkProgress ( const FName NamedChunk,
EChunkProgressReportingType::Type ReportType
)

 Get the current install progress of the given named chunk. GenericPlatform/GenericPlatformChunkInstall.h  

TArray< FName > GetNamedChunksByType ( ENamedChunkType NamedChunkType
) const

 Get a list of all the named chunks of the given type GenericPlatform/GenericPlatformChunkInstall.h  

ENamedChunkType GetNamedChunkType ( const FName NamedChunk
) const

 Query the type of the given named chunk GenericPlatform/GenericPlatformChunkInstall.h  

EChunkLocation::Type GetPakchunkLocation ( int32 PakchunkIndex
)

 Get the current location of a chunk with pakchunk index. GenericPlatform/GenericPlatformChunkInstall.h  

bool GetPakFilesInNamedChunk ( const FName NamedChunk,
TArray< FString >& OutFilesInChunk
) const

 Get the list of pak files in the given named chunk. GenericPlatform/GenericPlatformChunkInstall.h  

bool GetProgressReportingTypeSupported ( EChunkProgressReportingType::Type ReportType
)

 Check if a given reporting type is supported. GenericPlatform/GenericPlatformChunkInstall.h  

bool InstallNamedChunk ( const FName NamedChunk
)

 Install the given named chunk GenericPlatform/GenericPlatformChunkInstall.h  

bool InstallNamedChunks ( const TArrayView< const FName >& NamedChunks
)

 Install the given set of named chunks GenericPlatform/GenericPlatformChunkInstall.h  

bool IsAvailable()

 Returns whether chunk installation is available (i.e. we are an installed packaged build etc) GenericPlatform/GenericPlatformChunkInstall.h  

bool IsNamedChunkForCurrentLocale ( const FName NamedChunk
) const

 Determine if the given named chunk is suitable for the current system locale GenericPlatform/GenericPlatformChunkInstall.h  

bool IsNamedChunkInProgress ( const FName NamedChunk
)

 Check whether the give chunk is being installed GenericPlatform/GenericPlatformChunkInstall.h  

bool PrioritizeNamedChunk ( const FName NamedChunk,
EChunkPriority::Type Priority
)

 Hint to the installer that we would like to prioritize a specific chunk GenericPlatform/GenericPlatformChunkInstall.h  

bool PrioritizePakchunk ( int32 PakchunkIndex,
EChunkPriority::Type Priority
)

 Hint to the installer that we would like to prioritize a specific chunk GenericPlatform/GenericPlatformChunkInstall.h  

void RemoveChunkInstallDelegate ( FDelegateHandle Delegate
)

 Remove a delegate callback on chunk install completion. GenericPlatform/GenericPlatformChunkInstall.h  

void RemoveNamedChunkCompleteDelegate ( FDelegateHandle Delegate
)

 Remove a delegate callback on named chunk install completion. GenericPlatform/GenericPlatformChunkInstall.h  

void RemoveNamedChunkInstallDelegate ( FDelegateHandle Delegate
)

 Remove a delegate callback on named chunk install completion. GenericPlatform/GenericPlatformChunkInstall.h  

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  

bool SetInstallSpeed ( EChunkInstallSpeed::Type InstallSpeed
)

 Specify the priority of chunk installation vs. game IO. GenericPlatform/GenericPlatformChunkInstall.h  

bool SupportsBundleSource()

 Returns whether this platform chunk installer implements all the API functions to support the platform chunk install bundle source GenericPlatform/GenericPlatformChunkInstall.h  

bool SupportsNamedChunkInstall()

 Check whether current platform supports chunk installation by name GenericPlatform/GenericPlatformChunkInstall.h  

bool UninstallNamedChunk ( const FName NamedChunk
)

 Uninstall the given named chunk GenericPlatform/GenericPlatformChunkInstall.h  

bool UninstallNamedChunks ( const TArrayView< const FName >& NamedChunks
)

 Uninstall the given set of named chunks GenericPlatform/GenericPlatformChunkInstall.h  

Protected

Name Remarks Include Path Unreal Specifiers
Get the current location of a chunk. GenericPlatform/GenericPlatformChunkInstall.h  

bool PrioritizeChunk ( uint32 ChunkID,
EChunkPriority::Type Priority
)

 Hint to the installer that we would like to prioritize a specific chunk GenericPlatform/GenericPlatformChunkInstall.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page