1. Epic GamesDeveloper
  3. FBaseAsyncSaveGameSystem

FBaseAsyncSaveGameSystem

Helper base class for async-compatible save games

API > API/Runtime > API/Runtime/Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/SaveGameSystem.h
Include #include "SaveGameSystem.h"

Syntax

class FBaseAsyncSaveGameSystem : public ISaveGameSystem

Remarks

Helper base class for async-compatible save games

Functions

  Type Name Description
Protected function UE::Tasks::FTask

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

  
Protected function 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
Protected function UE::Tasks::FTask

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

  
Protected function UE::Tasks::FTask

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

  
Protected function UE::Tasks::FTask

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

  
Protected function Virtual void Specializations can override this

Overridden from ISaveGameSystem

  Type Name Description
Public function Virtual bool

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

 Delete an existing save game, blocking until complete
Public function Virtual void

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

 Delete the named savegame asyncronously.
Public function Virtual bool

DoesSaveGameExist ( const TCHAR* Name,
const int32 UserIndex
)

 Return true if the named savegame exists (probably not useful with NativeUI
Public function Virtual void

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

 Asyncronous save functions
Public function Virtual ESaveExistsResult

DoesSaveGameExistWithResult ( const TCHAR* Name,
const int32 UserIndex
)

 Syncronous save functions
Public function Virtual bool

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

 Gets a list of all known saves. This isn't possible on all platforms.
Public function Virtual void Gets a list of all known saves if the platform supports it.
Public function Virtual bool

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

 Loads the game, blocking until complete
Public function Virtual void

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

 Load the named savegame asyncronously.
Public function Virtual bool

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

 Saves the game, blocking until complete.
Public function Virtual void

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

 Saves the named savegame asyncronously.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page