IPlatformChunkInstall

Inheritance Hierarchy

Syntax

class IPlatformChunkInstall

Remarks

Interface for platform specific chunk based install

Destructors

Name Description

Public function Virtual

~IPlatformChunkInstall()

Virtual destructor

Functions

Name Description

Public function

FDelegateHan ...

 

AddChunkInstallDelegate

(
    FPlatformChunkInstallDelegate Deleg...
)

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

Public function

bool

 

DebugStartNextChunk()

For platforms that support emulation of the Chunk install.

Public function

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

EChunkLocati ...

 

GetChunkLocation

(
    uint32 ChunkID
)

Get the current location of a chunk.

Public function

float

 

GetChunkProgress

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

Get the current install progress of a chunk.

Public function

EChunkInstal ...

 

GetInstallSpeed()

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

Public function

bool

 

GetProgressReportingTypeSupported

Check if a given reporting type is supported.

Public function

bool

 

InstallChunks

(
    const TArray < FChunkTagID > ChunkTa...
)

Install chunks with Intelligent Delivery API

Public function

bool

 

IsChunkInstallationPending

(
    const TArray < FChunkTagID > ChunkTa...
)

Check whether installation of chunks are pending

Public function

bool

 

PrioritizeChunk

(
    uint32 ChunkID,
    EChunkPriority::Type Priority
)

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

Public function

void

 

RemoveChunkInstallDelegate

(
    FDelegateHandle Delegate
)

Remove a delegate callback on chunk install completion.

Public function

bool

 

SetInstallSpeed

(
    EChunkInstallSpeed::Type InstallSpe...
)

Specify the priority of chunk installation vs. game IO.

Public function

bool

 

SupportsIntelligentInstall()

Check whether current platform supports intelligent chunk installation

Public function

bool

 

UninstallChunks

(
    const TArray < FChunkTagID > ChunkTa...
)

Uninstall chunks with Intelligent Delivery API

Deprecated Functions

Name Description

Public function

void

 

RemoveChunkInstallDelgate

(
    uint32 ChunkID,
    FDelegateHandle Delegate
)

Call RemoveChunkInstallDelegate instead

Public function

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