Navigation
API > API/Runtime > API/Runtime/Engine
Base class for the various platform interface classes.
| Name | UCloudStorageBase |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Engine/CloudStorageBase.h |
| Include Path | #include "Engine/CloudStorageBase.h" |
Syntax
UCLASS ()
class UCloudStorageBase : public UPlatformInterfaceBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPlatformInterfaceBase → UCloudStorageBase
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCloudStorageBase
(
const FObjectInitializer& ObjectInitializer |
Engine/CloudStorageBase.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bSuppressDelegateCalls | uint32 | If true, delegate callbacks should be skipped. | Engine/CloudStorageBase.h | |
| LocalCloudFiles | TArray< FString > | When using local storage (aka "cloud emulation"), this maintains a list of the file paths. | Engine/CloudStorageBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 CreateCloudDocument
(
const FString& Filename |
Create a new document in the cloud (uninitialized, unsaved, use the Write/Save functions) | Engine/CloudStorageBase.h | |
virtual FString GetCloudDocumentName
(
int32 Index |
Engine/CloudStorageBase.h | ||
virtual int32 GetNumCloudDocuments
(
bool bIsForConflict |
Engine/CloudStorageBase.h | ||
virtual void Init() |
Performs any initialization. | Engine/CloudStorageBase.h | |
virtual void ParseDocumentAsBytes
(
int32 Index, |
Once a document has been read in, use this to return a string representing the. | Engine/CloudStorageBase.h | |
virtual UObject * ParseDocumentAsObject
(
int32 Index, |
Once a document has been read in, use this to return a string representing the entire document. | Engine/CloudStorageBase.h | |
virtual FString ParseDocumentAsString
(
int32 Index, |
Once a document has been read in, use this to return a string representing the entire document. | Engine/CloudStorageBase.h | |
virtual bool QueryForCloudDocuments () |
Kick off an async query of documents that exist in the cloud. | Engine/CloudStorageBase.h | |
virtual bool ReadCloudDocument
(
int32 Index, |
Reads a document into memory (or whatever is needed so that the ParseDocumentAs* functions operate synchronously without stalling the game). | Engine/CloudStorageBase.h | |
virtual bool ReadKeyValue
(
const FString& KeyName, |
Initiate reading a key/value pair from cloud storage. | Engine/CloudStorageBase.h | |
virtual bool ResolveConflictWithNewestDocument() |
If there was a conflict notification, this will simply tell the cloud interface to choose the most recently modified version, and toss any others. | Engine/CloudStorageBase.h | |
virtual bool ResolveConflictWithVersionIndex
(
int32 Index |
If there was a conflict notification, this will tell the cloud interface to choose the version with a given Index to be the primary version, and to toss any others. | Engine/CloudStorageBase.h | |
virtual bool SaveDocumentWithBytes
(
int32 Index, |
Prepare a document for writing to the cloud with an array of bytes as input data. | Engine/CloudStorageBase.h | |
virtual bool SaveDocumentWithObject
(
int32 Index, |
Prepare a document for writing to the cloud with an object as input data. This is synchronous. | Engine/CloudStorageBase.h | |
virtual bool SaveDocumentWithString
(
int32 Index, |
Prepare a document for writing to the cloud with a string as input data. This is synchronous. | Engine/CloudStorageBase.h | |
virtual bool WriteCloudDocument
(
int32 Index |
Writes a document that has been already "saved" using the SaveDocumentWith* functions. | Engine/CloudStorageBase.h | |
virtual bool WriteKeyValue
(
const FString& KeyName, |
Write a key/value pair to the cloud. | Engine/CloudStorageBase.h |