Skip to main content
EOS Interfaces

User Cloud

warning

Requires EOSCore 2.0.1 and later.

The Online Subsystem implements IOnlineUserCloud with EOS Player Data Storage. Files saved with the User Cloud are stored per player in the cloud, and the player can read them again on any device they log in on.

Use it through the Online Subsystem interface. Blueprint users can get it with Get User Cloud Interface. The Blueprint functions in EOSCore > Player Data Storage do the same work with EOS names.

Requirements​

  • Player Data Storage is enabled for your product in the EOS Developer Portal.
  • The player is logged in with Epic Account and Product User ID, so the Online Subsystem knows which player the files belong to.

Functions​

User Cloud functionEOS functionCallback
EnumerateUserFilesEOS_PlayerDataStorage_QueryFileListOnEnumerateUserFilesComplete
GetUserFileListReads the list from the last enumerationNone
ReadUserFileEOS_PlayerDataStorage_ReadFileOnReadUserFileComplete
GetFileContentsReads the file from the local cacheNone
WriteUserFileEOS_PlayerDataStorage_WriteFileOnWriteUserFileComplete
CancelWriteUserFileEOS_PlayerDataStorageFileTransferRequest_CancelRequestOnWriteUserFileCanceled
DeleteUserFileEOS_PlayerDataStorage_DeleteFileOnDeleteUserFileComplete
ClearFiles, ClearFileClears the local cacheNone

Typical flow​

  1. Call EnumerateUserFiles and wait for OnEnumerateUserFilesComplete.
  2. Call ReadUserFile and wait for OnReadUserFileComplete, then GetFileContents to get the bytes.
  3. Call WriteUserFile with the bytes, and wait for OnWriteUserFileComplete.

Limits​

  • File names can be at most 64 bytes in UTF-8. A longer name makes WriteUserFile and ReadUserFile return false and log an error.
  • bCompressBeforeUpload is ignored. EOS does not compress player data.
  • RequestUsageInfo is not supported by EOS and returns false.
  • DeleteUserFile with bShouldLocallyDelete removes the file from the game's local cache. It does not clear the EOS cache.
  • The read and write functions do not run again for the same file while the first call is still running. The second call returns false.