Skip to main content
Version: 4.24

Online UserCloud Subsystem

This API reference documents what methods and events are supported by Online Subsystem Blueprints. For full documentation on this API, refer to the Unreal Engine documentation.

Need to use a method or event that's not currently supported? Please reach out to support.

Supported Events#

EventSupported?Unreal Engine DocsParameters
OnEnumerateUserFilesComplete✔Detailsbool bWasSuccessful
const FUniqueNetId& UserId
OnReadUserFileComplete✔Detailsbool bWasSuccessful
const FUniqueNetId& UserId
const FString& FileName
OnWriteUserFileProgress✔Detailsint32 BytesWritten
const FUniqueNetId& UserId
const FString& FileName
OnWriteUserFileComplete✔Detailsbool bWasSuccessful
const FUniqueNetId& UserId
const FString& FileName
OnWriteUserFileCanceled✔Detailsbool bWasSuccessful
const FUniqueNetId& UserId
const FString& FileName
OnDeleteUserFileComplete✔Detailsbool bWasSuccessful
const FUniqueNetId& UserId
const FString& FileName
OnRequestUsageInfoComplete Detailsbool bWasSuccessful
const FUniqueNetId& UserId
int64 BytesUsed
const TOptional<int64>& TotalQuota

Supported Functions#

FunctionSupported?Unreal Engine DocsParameters
GetFileContents✔Detailsconst FUniqueNetId& UserId
const FString& FileName
TArray<uint8>& FileContents
ClearFiles✔Detailsconst FUniqueNetId& UserId
ClearFile✔Detailsconst FUniqueNetId& UserId
const FString& FileName
EnumerateUserFiles✔ 🕔Detailsconst FUniqueNetId& UserId
GetUserFileList✔Detailsconst FUniqueNetId& UserId
TArray<FCloudFileHeader>& UserFiles
ReadUserFile✔ 🕔Detailsconst FUniqueNetId& UserId
const FString& FileName
WriteUserFile✔ 🕔Detailsconst FUniqueNetId& UserId
const FString& FileName
TArray<uint8>& FileContents
bool bCompressBeforeUpload
CancelWriteUserFile✔Detailsconst FUniqueNetId& UserId
const FString& FileName
DeleteUserFile✔ 🕔Detailsconst FUniqueNetId& UserId
const FString& FileName
bool bShouldCloudDelete
bool bShouldLocallyDelete
RequestUsageInfo✔Detailsconst FUniqueNetId& UserId
DumpCloudState✔Detailsconst FUniqueNetId& UserId
DumpCloudFileState✔Detailsconst FUniqueNetId& UserId
const FString& FileName