UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FIOSChunkInstall Class Reference

#include <IOSChunkInstaller.h>

+ Inheritance diagram for FIOSChunkInstall:

Public Member Functions

 FIOSChunkInstall ()
 
virtual ~FIOSChunkInstall ()
 
virtual bool GetProgressReportingTypeSupported (EChunkProgressReportingType::Type ReportType) override
 
virtual float GetChunkProgress (uint32 ChunkID, EChunkProgressReportingType::Type ReportType) override
 
virtual EChunkInstallSpeed::Type GetInstallSpeed () override
 
virtual bool SetInstallSpeed (EChunkInstallSpeed::Type InstallSpeed) override
 
virtual bool PrioritizeChunk (uint32 ChunkID, EChunkPriority::Type Priority) override
 
virtual bool DebugStartNextChunk () override
 
- Public Member Functions inherited from FGenericPlatformChunkInstall
virtual CORE_API void AsyncInit (TFunction< void(bool)> OnInitComplete) override
 
virtual bool IsAvailable () const
 
virtual EChunkLocation::Type GetPakchunkLocation (int32 PakchunkIndex) override
 
virtual bool PrioritizePakchunk (int32 PakchunkIndex, EChunkPriority::Type Priority)
 
virtual void ExternalNotifyChunkAvailable (uint32 InChunkID) override
 
virtual FDelegateHandle AddChunkInstallDelegate (FPlatformChunkInstallDelegate Delegate) override
 
virtual void RemoveChunkInstallDelegate (FDelegateHandle Delegate) override
 
virtual bool SupportsNamedChunkInstall () const override
 
virtual bool IsNamedChunkInProgress (const FName NamedChunk) override
 
virtual bool InstallNamedChunk (const FName NamedChunk) override
 
virtual bool UninstallNamedChunk (const FName NamedChunk) override
 
virtual bool InstallNamedChunks (const TArrayView< const FName > &NamedChunks) override
 
virtual bool UninstallNamedChunks (const TArrayView< const FName > &NamedChunks) override
 
virtual EChunkLocation::Type GetNamedChunkLocation (const FName NamedChunk) override
 
virtual float GetNamedChunkProgress (const FName NamedChunk, EChunkProgressReportingType::Type ReportType) override
 
virtual bool PrioritizeNamedChunk (const FName NamedChunk, EChunkPriority::Type Priority) override
 
virtual ENamedChunkType GetNamedChunkType (const FName NamedChunk) const override
 
virtual TArray< FName > GetNamedChunksByType (ENamedChunkType NamedChunkType) const override
 
virtual void RemoveNamedChunkCompleteDelegate (FDelegateHandle Delegate) override
 
virtual FDelegateHandle AddNamedChunkCompleteDelegate (FPlatformNamedChunkCompleteDelegate Delegate) override
 
virtual bool SupportsBundleSource () const override
 
virtual bool SetAutoPakMountingEnabled (bool bEnabled)
 
virtual bool GetPakFilesInNamedChunk (const FName NamedChunk, TArray< FString > &OutFilesInChunk) const override
 
virtual bool GetNamedChunkInstallationStatus (const FName NamedChunk, FChunkInstallationStatusDetail &OutChunkStatusDetail) const override
 
virtual bool IsNamedChunkForCurrentLocale (const FName NamedChunk) const
 
- Public Member Functions inherited from IPlatformChunkInstall
virtual ~IPlatformChunkInstall ()
 

Additional Inherited Members

- Protected Member Functions inherited from FGenericPlatformChunkInstall
CORE_API void DoNamedChunkCompleteCallbacks (const FName NamedChunk, EChunkLocation::Type Location, bool bHasSucceeded) const
 
CORE_API void DoNamedChunkCompleteCallbacks (const TArrayView< const FName > &NamedChunks, EChunkLocation::Type Location, bool bHasSucceeded) const
 
- Protected Attributes inherited from FGenericPlatformChunkInstall
FPlatformChunkInstallMultiDelegate InstallDelegate
 
FPlatformNamedChunkCompleteMultiDelegate NamedChunkCompleteDelegate
 

Detailed Description

IOS implementation of FGenericPlatformChunkInstall.

Constructor & Destructor Documentation

◆ FIOSChunkInstall()

FIOSChunkInstall::FIOSChunkInstall ( )

◆ ~FIOSChunkInstall()

FIOSChunkInstall::~FIOSChunkInstall ( )
virtual

Member Function Documentation

◆ DebugStartNextChunk()

bool FIOSChunkInstall::DebugStartNextChunk ( )
overridevirtual

Debug function to start transfer of next chunk in the transfer list. When in PlayGo HostFS emulation, this is the only way moving out of network-local will happen for a chunk. Does nothing in a shipping build.

Returns
true if the operation succeeds.

Reimplemented from FGenericPlatformChunkInstall.

◆ GetChunkProgress()

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

Get the current install progress of a chunk. Let the user specify report type for platforms that support more than one.

Parameters
ChunkIDThe id of the chunk to check.
ReportTypeThe type of progress report you want.
Returns
A value whose meaning is dependent on the ReportType param.

Reimplemented from FGenericPlatformChunkInstall.

◆ GetInstallSpeed()

EChunkInstallSpeed::Type FIOSChunkInstall::GetInstallSpeed ( )
overridevirtual

Inquire about the priority of chunk installation vs. game IO.

Returns
Paused, low or high priority.

Reimplemented from FGenericPlatformChunkInstall.

◆ GetProgressReportingTypeSupported()

bool FIOSChunkInstall::GetProgressReportingTypeSupported ( EChunkProgressReportingType::Type  ReportType)
overridevirtual

Check if a given reporting type is supported.

Parameters
ReportTypeEnum specifying how progress is reported.
Returns
true if reporting type is supported on the current platform.

Reimplemented from FGenericPlatformChunkInstall.

◆ PrioritizeChunk()

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

Hint to the installer that we would like to prioritize a specific chunk

Parameters
ChunkIDThe id of the chunk to prioritize.
PriorityThe priority for the chunk.
Returns
false if the operation is not allowed or the chunk doesn't exist, otherwise true.

Reimplemented from FGenericPlatformChunkInstall.

◆ SetInstallSpeed()

bool FIOSChunkInstall::SetInstallSpeed ( EChunkInstallSpeed::Type  InstallSpeed)
overridevirtual

Specify the priority of chunk installation vs. game IO.

Parameters
InstallSpeedPause, low or high priority.
Returns
false if the operation is not allowed, otherwise true.

Reimplemented from FGenericPlatformChunkInstall.

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