ICloudTitleFile

Windows
MacOS
Linux

Inheritance Hierarchy

ICloudTitleFile

FLocalTitleFile

References

Module

HTTPChunkInstaller

Header

/Engine/Plugins/Runtime/HTTPChunkInstaller/Source/Public/CloudTitleFileInterface.h

Include

#include "CloudTitleFileInterface.h"

Syntax

class ICloudTitleFile

Variables

Name Description

Public variable

FOnEnumerateFil...

 

OnEnumerateFilesCompleteDelegates

Delegate fired when the list of files has been returned from the network store

Public variable

FOnReadFileComp...

 

OnReadFileCompleteDelegates

Delegate fired when a file read from the network platform's storage is complete

Public variable

FOnReadFileProg...

 

OnReadFileProgressDelegates

Delegate fired when as file read from the network platform's storage progresses

Constructors

Name Description

Protected function

ICloudTitleFile()

Destructors

Name Description

Public function Virtual

~ICloudTitleFile()

Functions

Name Description

Public function Virtual

FDelegateHan...

 

AddOnEnumerateFilesCompleteDelegate_Handle

(
    const FOnEnumerateFilesCompleteDele...
)

Public function Virtual

FDelegateHan...

 

AddOnReadFileCompleteDelegate_Handle

(
    const FOnReadFileCompleteDelegate&...
)

Public function Virtual

FDelegateHan...

 

AddOnReadFileProgressDelegate_Handle

(
    const FOnReadFileProgressDelegate&...
)

Public function

bool

 

ClearFile

(
    const FString& FileName
)

Empties the cached data for this file if it is not being downloaded currently

Public function

bool

 

ClearFiles()

Empties the set of downloaded files if possible (no async tasks outstanding)

Public function Virtual

void

 

ClearOnEnumerateFilesCompleteDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnReadFileCompleteDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnReadFileProgressDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function

void

 

DeleteCachedFiles

(
    bool bSkipEnumerated
)

Delete cached files on disk

Public function

bool

 

EnumerateFiles

(
    const FCloudPagedQuery& Page
)

Requests a list of available files from the network store

Public function

bool

 

GetFileContents

(
    const FString& FileName,
    TArray< uint8 >& FileContents
)

Copies the file data into the specified buffer for the specified file

Public function

void

 

GetFileList

(
    TArray< FCloudHeader >& Files
)

Returns the list of files that was returned by the network store

Public function

bool

 

ReadFile

(
    const FString& FileName
)

Starts an asynchronous read of the specified file from the network platform's file store

Public function Virtual

void

 

TriggerOnEnumerateFilesCompleteDelegates

(
    bool Param1
)

Public function Virtual

void

 

TriggerOnReadFileCompleteDelegates

(
    bool Param1,
    const FString& Param2
)

Public function Virtual

void

 

TriggerOnReadFileProgressDelegates

(
    const FString& Param1,
    uint64 Param2
)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss