ISaveGameSystem

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

Windows
MacOS
Linux

Inheritance Hierarchy

ISaveGameSystem

FGenericSaveGameSystem

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

Name Description

Public function

bool

 

DeleteGame

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

Delete an existing save game, blocking until complete

Public function

bool

 

DoesSaveGameExist

(
    const TCHAR* Name,
    const int32 UserIndex
)

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

Public function

ESaveExistsR...

 

DoesSaveGameExistWithResult

(
    const TCHAR* Name,
    const int32 UserIndex
)

Similar to DoesSaveGameExist, except returns a result code with more information.

Public function

bool

 

LoadGame

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

Loads the game, blocking until complete

Public function

bool

 

PlatformHasNativeUI()

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.

Enums

Name

Description

Public enum

ESaveExistsResult

Possible result codes when using DoesSaveGameExist.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss