FGenericPlatformChunkInstall

Inheritance Hierarchy

Syntax

class FGenericPlatformChunkInstall : public IPlatformChunkInstall

Remarks

Generic implementation of chunk based install

Variables

Name Description

Protected variable

FPlatformChunkI ...

 

InstallDelegate

Delegate called when installation succeeds or fails

Overridden from IPlatformChunkInstall

Name Description

Public function Virtual

FDelegateHan ...

 

AddChunkInstallDelegate

(
    FPlatformChunkInstallDelegate Deleg...
)

Request a delegate callback on chunk install completion or failure. Request may not be respected.

Public function Virtual

bool

 

DebugStartNextChunk()

For platforms that support emulation of the Chunk install.

Public function 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.

Public function Virtual

EChunkLocati ...

 

GetChunkLocation

(
    uint32 ChunkID
)

Get the current location of a chunk.

Public function Virtual

float

 

GetChunkProgress

(
    uint32 ChunkID,
    EChunkProgressReportingType::Type R...
)

Get the current install progress of a chunk.

Public function Virtual

EChunkInstal ...

 

GetInstallSpeed()

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

Public function Virtual

bool

 

GetProgressReportingTypeSupported

Check if a given reporting type is supported.

Public function Virtual

bool

 

InstallChunks

(
    const TArray < FChunkTagID > ChunkTa...
)

Install chunks with Intelligent Delivery API

Public function Virtual

bool

 

IsChunkInstallationPending

(
    const TArray < FChunkTagID > ChunkTa...
)

Check whether installation of chunks are pending

Public function Virtual

bool

 

PrioritizeChunk

(
    uint32 ChunkID,
    EChunkPriority::Type Priority
)

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

Public function Virtual

void

 

RemoveChunkInstallDelegate

(
    FDelegateHandle Delegate
)

Remove a delegate callback on chunk install completion.

Public function Virtual

bool

 

SetInstallSpeed

(
    EChunkInstallSpeed::Type InstallSpe...
)

Specify the priority of chunk installation vs. game IO.

Public function Virtual

bool

 

SupportsIntelligentInstall()

Check whether current platform supports intelligent chunk installation

Public function Virtual

bool

 

UninstallChunks

(
    const TArray < FChunkTagID > ChunkTa...
)

Uninstall chunks with Intelligent Delivery API

Deprecated Functions

Name Description

Public function Virtual

void

 

RemoveChunkInstallDelgate

(
    uint32 ChunkID,
    FDelegateHandle Delegate
)

Call RemoveChunkInstallDelegate instead

Public function Virtual

FDelegateHan ...

 

SetChunkInstallDelgate

(
    uint32 ChunkID,
    FPlatformChunkInstallCompleteDelega ...
)

Call AddChunkInstallDelegate instead, which is now bound for all chunk ids

References

Module

Core

Header

Runtime/Core/Public/GenericPlatform/GenericPlatformChunkInstall.h