1. Epic GamesDeveloper
  3. ULocalPlayerSaveGame

ULocalPlayerSaveGame

Abstract subclass of [USaveGame](API\Runtime\Engine\GameFramework\USaveGame) that provides utility functions that let you associate a Save Game object with a specific local player.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/GameFramework

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/GameFramework/SaveGame.h
Include #include "GameFramework/SaveGame.h"

Syntax

UCLASS (Abstract, Blueprintable, BlueprintType, MinimalAPI)  
class ULocalPlayerSaveGame : public USaveGame

Remarks

Abstract subclass of USaveGame that provides utility functions that let you associate a Save Game object with a specific local player. These objects can also be loaded using the functions on GameplayStatics, but you would need to call functions like InitializeSaveGame manually. For simple games, it is fine to blueprint this class directly and add parameters and override functions in blueprint, but for complicated games you will want to subclass this in native code and set up proper versioning.

Variables

  Type Name Description
Protected variable UProperty Transient int32 CurrentSaveRequest Integer that is incremented every time a save has been requested in the current session, can be used to know if one is in progress
Protected variable UProperty Transient int32 LastErrorSaveRequest Integer that is set when a save fails
Protected variable UProperty Transient int32 LastSuccessfulSaveRequest Integer that is set when a save completes successfully, if this equals RequestedSaveCount then the last save was successful
Protected variable UProperty Transient int32 LoadedDataVersion The value of SavedDataVersion when a save was last loaded, this will be -1 for newly created saves
Protected variable UProperty Transient TObjectPtr< const ULocalPlayer > OwningPlayer The local player this is connected to, can be null if subclasses override Get/Set Local Player or it hasn't been initialized
Protected variable UProperty int32 SavedDataVersion The value of GetLatestDataVersion when this was last saved.
Protected variable UProperty Transient FString SaveSlotName The slot name this was loaded from and that will be used to save to in the future

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category bool Asynchronously loads a save game object in the specified slot for the local player, if this returns true the delegate will get called later.
Public function Static bool Native version of above function, this takes a ULocalPlayer and calls a native delegate.
Public function Virtual UFunction BlueprintCallable, Category bool Asynchronously save to the slot and user index.
Public function Static ULocalPlayerSaveGame *

CreateNewSaveGameForLocalPlayer ( TSubclassOf< ULocalPlayerSaveGame > SaveGameClass,
const ULocalPlayer* LocalPlayer,
const FString& SlotName
)

 Create a brand new save game, possibly ready for saving but without trying to load from disk.
Public function Virtual Const UFunction BlueprintCallable, Category int32 Returns the invalid save data version, which means it has never been saved/loaded
Public function Virtual Const UFunction BlueprintCallable, Category int32 Returns the latest save data version, this is used when the new data is saved
Public function Virtual Const const ULocalPlayer * Returns the local player this is associated with, this will be valid if it is ready to save
Public function Virtual Const UFunction BlueprintCallable, Category APlayerController * Returns the local player controller this is associated with, this will be valid if it is ready to save
Public function Virtual Const UFunction BlueprintCallable, Category FPlatformUserId Returns the platform user to save to, based on Local Player by default
Public function Virtual Const UFunction BlueprintCallable, Category int32 Returns the user index to save to, based on Local Player by default
Public function Virtual Const UFunction BlueprintCallable, Category int32 Returns the game-specific version number this was last saved/loaded as
Public function Virtual Const UFunction BlueprintCallable, Category FString Returns the save slot name to use
Public function Virtual void Called after loading, this is not called for newly created saves
Public function Virtual void

HandlePostSave ( bool bSuccess
)

 Called after saving finishes with success/failure result
Public function Virtual void Called before saving, do any game-specific fixup here
Public function Virtual void

InitializeSaveGame ( const ULocalPlayer* LocalPlayer,
FString InSlotName,
bool bWasLoaded
)

 Initializes this save after either loading or initial creation, automatically called by load/create functions above
Public function Virtual Const UFunction BlueprintCallable, Category bool Returns true if a save is in progress
Public function Static ULocalPlayerSaveGame *

LoadOrCreateSaveGameForLocalPlayer ( TSubclassOf< ULocalPlayerSaveGame > SaveGameClass,
const ULocalPlayer* LocalPlayer,
const FString& SlotName
)

 Native version of above function, this takes a ULocalPlayer because you can have a local player before a player controller.
Public function Static UFunction BlueprintCallable, Category ULocalPlayerSaveGame *

LoadOrCreateSaveGameForLocalPlayer ( TSubclassOf< ULocalPlayerSaveGame > SaveGameClass,
APlayerController* LocalPlayerController,
const FString& SlotName
)

 Synchronously loads a save game object in the specified slot for the local player, stalling the main thread until it completes.
Public function UFunction Category, BlueprintImplementableEvent void Blueprint event called after loading, is not called for newly created saves
Public function UFunction Category, BlueprintImplementableEvent void

OnPostSave ( bool bSuccess
)

 Blueprint event called after saving finishes with success/failure result
Public function UFunction Category, BlueprintImplementableEvent void Blueprint event called before saving, do any game-specific fixup here
Public function UFunction Category, BlueprintImplementableEvent void Blueprint event called to reset all saved data to default, called when the load fails or manually
Protected function Static ULocalPlayerSaveGame *

ProcessLoadedSave ( USaveGame* BaseSave,
const FString& SlotName,
const int32 UserIndex,
TSubclassOf< ULocalPlayerSaveGame > SaveGameClass,
const ULocalPlayer* LocalPlayer
)

 Internal helper function used by both the sync and async save
Protected function Virtual void

ProcessSaveComplete ( const FString& SlotName,
const int32 UserIndex,
bool bSuccess,
int32 SaveRequest
)

 Internal callback that will call HandlePostSave
Public function Virtual UFunction BlueprintCallable, Category void Resets all saved data to default values, called when the load fails or manually
Public function Virtual UFunction BlueprintCallable, Category bool Synchronously save using the slot and user index, stalling the main thread until it completes.
Public function Virtual void

SetLocalPlayer ( const ULocalPlayer* LocalPlayer
)

 Associates this save game with a local player, this is called automatically during load/create
Public function Virtual void

SetSaveSlotName ( const FString& SlotName
)

 Sets the save slot name for any future saves
Public function Virtual Const UFunction BlueprintCallable, Category bool Returns true if it has been saved at least once and the last save was successful
Public function Virtual Const UFunction BlueprintCallable, Category bool Returns true if this was loaded from an existing save
Public function Virtual Const UFunction BlueprintCallable, Category bool Returns true if a save was ever requested, may still be in progress

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page