IPlatformChunkInstall

Interface for platform specific chunk based install

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/GenericPlatform

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformChunkInstall.h
Include #include "GenericPlatform/GenericPlatformChunkInstall.h"

Syntax

class IPlatformChunkInstall

Remarks

Interface for platform specific chunk based install

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function FDelegateHandle

AddChunkInstallDelegate ( FPlatformChunkInstallDelegate Delegate
)

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

AddNamedChunkInstallDelegate ( FPlatformNamedChunkInstallDelegate Delegate
)

 Request a delegate callback on named chunk install completion or failure.
Public function bool 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.
Protected function EChunkLocation::Type

GetChunkLocation ( uint32 ChunkID
)

 Get the current location of a chunk.
Public function float

GetChunkProgress ( uint32 ChunkID,
EChunkProgressReportingType::Type ReportType
)

 Get the current install progress of a chunk.
Public function EChunkInstallSpeed::Type Inquire about the priority of chunk installation vs. game IO.
Public function EChunkLocation::Type

GetNamedChunkLocation ( const FName NamedChunk
)

 Get the current location of the given named chunk
Public function float Get the current install progress of the given named chunk.
Public function Const TArray< FName >

GetNamedChunksByType ( ENamedChunkType NamedChunkType
)

 Get a list of all the named chunks of the given type
Public function Const ENamedChunkType

GetNamedChunkType ( const FName NamedChunk
)

 Query the type of the given named chunk
Public function EChunkLocation::Type

GetPakchunkLocation ( int32 PakchunkIndex
)

 Get the current location of a chunk with pakchunk index.
Public function bool Check if a given reporting type is supported.
Public function bool

InstallNamedChunk ( const FName NamedChunk
)

 Install the given named chunk
Public function bool

InstallNamedChunks ( const TArrayView< const FName >& NamedChunks
)

 Install the given set of named chunks
Public function bool

IsNamedChunkInProgress ( const FName NamedChunk
)

 Check whether the give chunk is being installed
Protected function bool

PrioritizeChunk ( uint32 ChunkID,
EChunkPriority::Type Priority
)

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

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

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

PrioritizePakchunk ( int32 PakchunkIndex,
EChunkPriority::Type Priority
)

 Hint to the installer that we would like to prioritize a specific chunk
Public function void Remove a delegate callback on chunk install completion.
Public function void Remove a delegate callback on named chunk install completion.
Public function bool Specify the priority of chunk installation vs. game IO.
Public function Const bool Check whether current platform supports chunk installation by name
Public function bool

UninstallNamedChunk ( const FName NamedChunk
)

 Uninstall the given named chunk
Public function bool

UninstallNamedChunks ( const TArrayView< const FName >& NamedChunks
)

 Uninstall the given set of named chunks

Deprecated Functions

  Type Name Description
Public function TArray< FCustomChunk >

GetCustomChunksByType ( ECustomChunkType DesiredChunkType
)

 Call GetNamedChunksByType instead
Public function bool

InstallChunks ( const TArray< FCustomChunk >& ChunkTagsID
)

 Call InstallNamedChunks instead
Public function bool

IsChunkInstallationPending ( const TArray< FCustomChunk >& ChunkTagsID
)

 Call IsNamedChunkInProgress instead
Public function bool Call SupportsNamedChunkInstall instead
Public function bool

UninstallChunks ( const TArray< FCustomChunk >& ChunkTagsID
)

 Call UninstallNamedChunks instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page