1. Epic GamesDeveloper
  3. FBaseAsyncSaveGameSystem

FBaseAsyncSaveGameSystem

Helper base class for async-compatible save games

API > API/Runtime > API/Runtime/Engine

Helper base class for async-compatible save games

   
Name FBaseAsyncSaveGameSystem
Type class
Header File /Engine/Source/Runtime/Engine/Public/SaveGameSystem.h
Include Path #include "SaveGameSystem.h"

Syntax

class FBaseAsyncSaveGameSystem : public ISaveGameSystem

Implements Interfaces

Functions

Public

Overridden from ISaveGameSystem

Name Remarks Include Path Unreal Specifiers

virtual bool DeleteGame ( bool bAttemptToUseUI,
const TCHAR* Name,
const int32 UserIndex
)

 Delete an existing save game, blocking until complete SaveGameSystem.h  

virtual void DeleteGameAsync ( bool bAttemptToUseUI,
const TCHAR* Name,
FPlatformUserId PlatformUserId,
FSaveGameAsyncOpCompleteCallback Callback
)

 Delete the named savegame asyncronously. SaveGameSystem.h  

virtual bool DoesSaveGameExist ( const TCHAR* Name,
const int32 UserIndex
)

 Return true if the named savegame exists (probably not useful with NativeUI SaveGameSystem.h  

virtual void DoesSaveGameExistAsync ( const TCHAR* Name,
FPlatformUserId PlatformUserId,
FSaveGameAsyncExistsCallback Callback
)

 Asyncronous save functions SaveGameSystem.h  

virtual ESaveExistsResult DoesSaveGameExistWithResult ( const TCHAR* Name,
const int32 UserIndex
)

 Syncronous save functions SaveGameSystem.h  

virtual bool GetSaveGameNames ( TArray< FString >& FoundSaves,
const int32 UserIndex
)

 Gets a list of all known saves. This isn't possible on all platforms. SaveGameSystem.h  

virtual void GetSaveGameNamesAsync ( FPlatformUserId PlatformUserId,
FSaveGameAsyncGetNamesCallback Callback
)

 Gets a list of all known saves if the platform supports it. SaveGameSystem.h  

virtual bool LoadGame ( bool bAttemptToUseUI,
const TCHAR* Name,
const int32 UserIndex,
TArray< uint8 >& Data
)

 Loads the game, blocking until complete SaveGameSystem.h  

virtual void LoadGameAsync ( bool bAttemptToUseUI,
const TCHAR* Name,
FPlatformUserId PlatformUserId,
FSaveGameAsyncLoadCompleteCallback Callback
)

 Load the named savegame asyncronously. SaveGameSystem.h  

virtual void LoadGameIfExistsAsync ( bool bAttemptToUseUI,
const TCHAR* Name,
FPlatformUserId PlatformUserId,
FSaveGameAsyncLoadCompleteCallback Callback
)

 Combines DoesSaveGameExistAsync and LoadGameAsync into one operation for simpler usage, treats all errors as the save game not existing SaveGameSystem.h  

virtual bool SaveGame ( bool bAttemptToUseUI,
const TCHAR* Name,
const int32 UserIndex,
const TArray< uint8 >& Data
)

 Saves the game, blocking until complete. SaveGameSystem.h  

virtual void SaveGameAsync ( bool bAttemptToUseUI,
const TCHAR* Name,
FPlatformUserId PlatformUserId,
TSharedRef< const TArray< uint8 > > Data,
FSaveGameAsyncOpCompleteCallback Callback
)

 Saves the named savegame asyncronously. SaveGameSystem.h  

Protected

Name Remarks Include Path Unreal Specifiers

UE::Tasks::FTask InternalDeleteGameAsync ( bool bAttemptToUseUI,
const TCHAR* Name,
FPlatformUserId PlatformUserId,
FSaveGameAsyncOpCompleteCallback Callback,
TSharedPtr< bool > OutResult
)

   SaveGameSystem.h  

UE::Tasks::FTask InternalDoesSaveGameExistAsync ( const TCHAR* Name,
FPlatformUserId PlatformUserId,
FSaveGameAsyncExistsCallback Callback,
TSharedPtr< ESaveExistsResult > OutResult
)

 Internal async helpers that require implementation. NB. OutResult will be null for async calls SaveGameSystem.h  

UE::Tasks::FTask InternalGetSaveGameNamesAsync ( FPlatformUserId PlatformUserId,
TSharedRef< TArray< FString > > FoundSaves,
FSaveGameAsyncGetNamesCallback Callback,
TSharedPtr< bool > OutResult
)

   SaveGameSystem.h  

UE::Tasks::FTask InternalLoadGameAsync ( bool bAttemptToUseUI,
const TCHAR* Name,
FPlatformUserId PlatformUserId,
TSharedRef< TArray< uint8 > > Data,
FSaveGameAsyncLoadCompleteCallback Callback,
TSharedPtr< bool > OutResult
)

   SaveGameSystem.h  

UE::Tasks::FTask InternalSaveGameAsync ( bool bAttemptToUseUI,
const TCHAR* Name,
FPlatformUserId PlatformUserId,
TSharedRef< const TArray< uint8 > > Data,
FSaveGameAsyncOpCompleteCallback Callback,
TSharedPtr< bool > OutResult
)

   SaveGameSystem.h  

virtual void WaitForAsyncTask ( UE::Tasks::FTask AsyncSaveTask
)

 Specializations can override this SaveGameSystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page