The Remote Storage abstraction of the GamePlatform plugin attempts to unify the interfaces for user storage on platform services.
This can, for example, be used to store saved files on a remote cloud service on the platform. The remote files handled by the Remote Storage interface can be shared to allow other clients to download and make use of the files.
To allow a more seamless usage of Flow Graph with respect to the Remote Storage interface, a Remote File Cache which resides in the GamePlatformNodes plugin is used.
You must remember to clear this cache when you are not using the remote files any more; you can do this per file, or every file per platform.
Alongside the Remote Storage system, CRYENGINE also provides an interface into the User Generated Content service for Steam. This allows the creation of Workshop Items directly in your game.
Checks if the remote storage capability is available on the platform.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteStorage::IsEnabled |
Flow Graph Nodes | GamePlatform:RemoteStorage:IsEnabled |
Schematyc Nodes | Function::GamePlatform::Service::RemoteStorage::IsEnabled |
Retrieves a reference to a remote file.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteStorage::GetFile |
Flow Graph Nodes | N/A (handled via the file cache) |
Schematyc Nodes | Function::GamePlatform::Service::RemoteStorage::GetRemoteFileByName |
Retrieves a reference to a shared remote file.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteStorage::GetSharedFile |
Flow Graph Nodes | N/A (handled via the file cache) |
Schematyc Nodes | Function::GamePlatform::Service::RemoteStorage::GetSharedFileById |
Fired when a download request for a shared file is completed.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteFileBase::IListener::OnDownloadedSharedFile |
Flow Graph Nodes | GamePlatform:Listener:RemoteStorage:OnDownloadedSharedFile |
Schematyc Nodes | Signal::Receive::[EntityName]::Accounts::PlatformSignalReceiver::RemoteStorage::OnDownloadedSharedFile |
Fired when a file has been shared by the local user.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteFileBase::IListener::::OnFileShared |
Flow Graph Nodes | GamePlatform:Listener:RemoteStorage:OnFileShared |
Schematyc Nodes | Signal::Receive::[EntityName]::Accounts::PlatformSignalReceiver::RemoteStorage::OnFileShared |
Attempts to delete a file from remote storage.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteFile::Delete |
Flow Graph Nodes | GamePlatform:RemoteStorage:DeleteRemoteFile |
Schematyc Nodes | Function::GamePlatform::Service::RemoteStorage::DeleteRemoteFile |
Attempts to download the specified shared file from remote storage.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::ISharedRemoteFile::Download |
Flow Graph Nodes | GamePlatform:RemoteStorage:DownloadSharedFile |
Schematyc Nodes | Function::GamePlatform::Service::RemoteStorage::SharedFile::Download |
Checks to see if the specified file exists on the remote storage.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteFile::Exists |
Flow Graph Nodes | GamePlatform:RemoteStorage:FileExists |
Schematyc Nodes | Function::GamePlatform::Service::RemoteStorage::RemoteFile::Exists |
Retrieves all cached files of the specified type in memory for the specified platform.
This function is not functional in Release builds; it will not compile (if not guarded) in Release builds, and is to be used for debugging purposes only.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteStorageCache::VisitCache |
Flow Graph Nodes | GamePlatform:RemoteStorage:GetCacheList |
Schematyc Nodes | N/A (Not Implemented) |
Attempts to retrieve the size of a file from remote storage.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteFile::GetFileSize |
Flow Graph Nodes | GamePlatform:RemoteStorage:GetFileSize |
Schematyc Nodes | Function::GamePlatform::Service::RemoteFile::GetFileSize |
Attempts to retrieve the shared file ID of the specified remote file.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteFile::GetIdentifier |
Flow Graph Nodes | GamePlatform:RemoteStorage:GetSharedFileId |
Schematyc Nodes | Function::GamePlatform::Service::RemoteStorage::RemoteFile::GetSharedId |
Attempts to retrieve the size of a shared file from remote storage.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::ISharedRemoteFile::GetFileSize |
Flow Graph Nodes | GamePlatform:RemoteStorage:GetSharedFileSize |
Schematyc Nodes | Function::GamePlatform::Service::SharedFile::GetFileSize |
Attempts to read data from remote storage.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteFile::Read |
Flow Graph Nodes | GamePlatform:RemoteStorage:ReadData |
Schematyc Nodes | Function::GamePlatform::Service::RemoteStorage::RemoteFile::ReadData |
Attempts to read data from remote storage and write it to a local file.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteFile::ReadToFile |
Flow Graph Nodes | GamePlatform:RemoteStorage:ReadDataToFile |
Schematyc Nodes | Function::GamePlatform::Service::RemoteStorage::RemoteFile::ReadToFile |
Attempts to read a shared file from remote storage.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::ISharedRemoteFile::Read |
Flow Graph Nodes | GamePlatform:RemoteStorage:ReadSharedData |
Schematyc Nodes | Function::GamePlatform::Service::RemoteStorage::SharedFile::Read |
Attempts to read a shared file and write the data to the specified local file.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::ISharedRemoteFile::ReadToFile |
Flow Graph Nodes | GamePlatform:RemoteStorage:ReadSharedDataToFile |
Schematyc Nodes | Function::GamePlatform::Service::RemoteStorage::SharedFile::ReadToFile |
Releases a cached remote file from the remote storage cache.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteStorageCache::ReleaseCache |
Flow Graph Nodes | GamePlatform:RemoteStorage:ReleaseRemoteFile |
Schematyc Nodes | Function::GamePlatform::Service::RemoteStorage::RemoteFile::ReleaseCache |
Releases a cached shared file from the remote storage cache.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteStorageCache::ReleaseCache |
Flow Graph Nodes | GamePlatform:RemoteStorage:ReleaseSharedFile |
Schematyc Nodes | Function::GamePlatform::Service::RemoteStorage::SharedFile::ReleaseCache |
Attempts to share a file from remote storage.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteFile::Share |
Flow Graph Nodes | GamePlatform:RemoteStorage:ShareRemoteFile |
Schematyc Nodes | Function::GamePlatform::Service::RemoteStorage::RemoteFile::Share |
Attempts to write data from a local file to remote storage.
CryPak handles resolution of the path, and you can prefix %USER% or %ENGINEROOT% to the file paths. This means you can use all the aliases and even read data from files inside encrypted PAK files (data cannot be written to PAK files).
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteFile::WriteFromFile |
Flow Graph Nodes | GamePlatform:RemoteStorage:WriteDataFromFile |
Schematyc Nodes | Function::GamePlatform::Service::RemoteStorage::RemoteFile::WriteFromFile |
Attempts to write data to a file in remote storage.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IRemoteFile::Write |
Flow Graph Nodes | GamePlatform:RemoteStorage:WriteData |
Schematyc Nodes | Function::GamePlatform::Service::RemoteStorage::RemoteFile::Write |
Creates a new user generated content item on the specified platform.
Platforms | Steam |
---|---|
API | Cry::GamePlatform::IUserGeneratedContentManager::CreateDirect |
Flow Graph Nodes | GamePlatform:UserGeneratedContent:CreateContent |
Schematyc Nodes | Function::GamePlatform::Service::UserGeneratedContent::Create |