1. Epic GamesDeveloper
  3. ISaveGameSystem

ISaveGameSystem

Interface for platform feature modulesDefines the interface to platform's save game system (or a generic file based one)

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 ISaveGameSystem

Remarks

Interface for platform feature modulesDefines the interface to platform's save game system (or a generic file based one)

Functions

  Type Name Description
Public function 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 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
)

 Asyncronously checks if the named savegame exists.
Public function ESaveExistsResult

DoesSaveGameExistWithResult ( const TCHAR* Name,
const int32 UserIndex
)

 Similar to DoesSaveGameExist, except returns a result code with more information.
Public function bool Some save systems don't support more than one user, in those cases the game needs to avoid saving settings for anyone but the primary user.
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 void

InitAsync ( bool bAttemptToUseUI,
FPlatformUserId PlatformUserId,
FSaveGameAsyncInitCompleteCallback Callback
)

 (Optional) initialise the save system for the given user.
Public function 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.
Protected function void

OnAsyncComplete ( TFunction< void()> Callback
)

 Helper function for calling back to the game thread when an async save operation has completed
Public function bool Returns true if the platform has a native UI (like many consoles)
Public function 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.

Enums

  Type Name Description
Public enum ESaveExistsResult Possible result codes when using DoesSaveGameExist.  

Typedefs

Name Description
FSaveGameAsyncExistsCallback Indicates that an async savegame exists check has completed. SlotName, PlatformUserId, save exists result. Should always be called from the gamethread.
FSaveGameAsyncGetNamesCallback Indicates that an async savegame list names has completed. PlatformUserId, bool=success, FoundSaves. Should always be called from the game thread
FSaveGameAsyncInitCompleteCallback Indicates that an async savegame initialize has completed. PlatformUserId, bool=success. Should always be called from the gamethread.
FSaveGameAsyncLoadCompleteCallback Indicates that an async savegame load has completed. SlotName, PlatformUserId, bool=success, SavedData. Should always be called from the gamethread.
FSaveGameAsyncOpCompleteCallback Indicates that an async savegame operation has completed. SlotName, PlatformUserId, bool=success. Should always be called from the gamethread.

Constants

Name Description
AsyncTaskPipe Save task pipe prevents multiple async save operations happening in parallel. note that the order is not guaranteed

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page