SaveGame.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "Misc/CoreMiscDefines.h"
#include "SaveGame.generated.h"
 
class ULocalPlayer;
class APlayerController;
 
UCLASS(abstract, Blueprintable, BlueprintType, MinimalAPI)
class USaveGame : public UObject
{
    GENERATED_BODY()
};
 
 
DECLARE_DYNAMIC_DELEGATE_OneParam(FOnLocalPlayerSaveGameLoaded, class ULocalPlayerSaveGame*, SaveGame);
DECLARE_DELEGATE_OneParam(FOnLocalPlayerSaveGameLoadedNative, class ULocalPlayerSaveGame*);
 
UCLASS(abstract, Blueprintable, BlueprintType, MinimalAPI)
class ULocalPlayerSaveGame : public USaveGame
{
    GENERATED_BODY()
public:
 
    UFUNCTION(BlueprintCallable, Category = "SaveGame|LocalPlayer")
    static ENGINE_API ULocalPlayerSaveGame* LoadOrCreateSaveGameForLocalPlayer(TSubclassOf<ULocalPlayerSaveGame> SaveGameClass, APlayerController* LocalPlayerController, const FString& SlotName);
 
    static ENGINE_API ULocalPlayerSaveGame* LoadOrCreateSaveGameForLocalPlayer(TSubclassOf<ULocalPlayerSaveGame> SaveGameClass, const ULocalPlayer* LocalPlayer, const FString& SlotName);
 
    UFUNCTION(BlueprintCallable, Category = "SaveGame|LocalPlayer")
    static ENGINE_API bool AsyncLoadOrCreateSaveGameForLocalPlayer(TSubclassOf<ULocalPlayerSaveGame> SaveGameClass, APlayerController* LocalPlayerController, const FString& SlotName, FOnLocalPlayerSaveGameLoaded Delegate);
 
    static ENGINE_API bool AsyncLoadOrCreateSaveGameForLocalPlayer(TSubclassOf<ULocalPlayerSaveGame> SaveGameClass, const ULocalPlayer* LocalPlayer, const FString& SlotName, FOnLocalPlayerSaveGameLoadedNative Delegate);
 
    static ENGINE_API ULocalPlayerSaveGame* CreateNewSaveGameForLocalPlayer(TSubclassOf<ULocalPlayerSaveGame> SaveGameClass, const ULocalPlayer* LocalPlayer, const FString& SlotName);
 
    UFUNCTION(BlueprintCallable, Category = "SaveGame|LocalPlayer")
    ENGINE_API virtual bool SaveGameToSlotForLocalPlayer();
 
    UFUNCTION(BlueprintCallable, Category = "SaveGame|LocalPlayer")
    ENGINE_API virtual bool AsyncSaveGameToSlotForLocalPlayer();
 
 
    UFUNCTION(BlueprintCallable, Category = "SaveGame|LocalPlayer")
    ENGINE_API virtual APlayerController* GetLocalPlayerController() const;
 
    ENGINE_API virtual const ULocalPlayer* GetLocalPlayer() const;
 
    ENGINE_API virtual void SetLocalPlayer(const ULocalPlayer* LocalPlayer);
 
    UFUNCTION(BlueprintCallable, Category = "SaveGame|LocalPlayer")
    ENGINE_API virtual FPlatformUserId GetPlatformUserId() const;
 
    UFUNCTION(BlueprintCallable, Category = "SaveGame|LocalPlayer")
    ENGINE_API virtual int32 GetPlatformUserIndex() const;
 
    UFUNCTION(BlueprintCallable, Category = "SaveGame|LocalPlayer")
    ENGINE_API virtual FString GetSaveSlotName() const;
 
    ENGINE_API virtual void SetSaveSlotName(const FString& SlotName);
 
    UFUNCTION(BlueprintCallable, Category = "SaveGame|LocalPlayer")
    ENGINE_API virtual int32 GetSavedDataVersion() const;
 
    UFUNCTION(BlueprintCallable, Category = "SaveGame|LocalPlayer")
    ENGINE_API virtual int32 GetInvalidDataVersion() const;
 
    UFUNCTION(BlueprintCallable, Category = "SaveGame|LocalPlayer")
    ENGINE_API virtual int32 GetLatestDataVersion() const;
 
    UFUNCTION(BlueprintCallable, Category = "SaveGame|LocalPlayer")
    ENGINE_API virtual bool WasLoaded() const;
 
    UFUNCTION(BlueprintCallable, Category = "SaveGame|LocalPlayer")
    ENGINE_API virtual bool IsSaveInProgress() const;
 
    UFUNCTION(BlueprintCallable, Category = "SaveGame|LocalPlayer")
    ENGINE_API virtual bool WasLastSaveSuccessful() const;
 
    UFUNCTION(BlueprintCallable, Category = "SaveGame|LocalPlayer")
    ENGINE_API virtual bool WasSaveRequested() const;
 
 
    ENGINE_API virtual void InitializeSaveGame(const ULocalPlayer* LocalPlayer, FString InSlotName, bool bWasLoaded);
 
    UFUNCTION(BlueprintCallable, Category = "SaveGame|LocalPlayer")
    ENGINE_API virtual void ResetToDefault();
 
    UFUNCTION(BlueprintImplementableEvent, Category = "SaveGame|LocalPlayer")
    ENGINE_API void OnResetToDefault();
 
    ENGINE_API virtual void HandlePostLoad();
 
    UFUNCTION(BlueprintImplementableEvent, Category = "SaveGame|LocalPlayer")
    ENGINE_API void OnPostLoad();
 
    ENGINE_API virtual void HandlePreSave();
 
    UFUNCTION(BlueprintImplementableEvent, Category = "SaveGame|LocalPlayer")
    ENGINE_API void OnPreSave();
 
    ENGINE_API virtual void HandlePostSave(bool bSuccess);
 
    UFUNCTION(BlueprintImplementableEvent, Category = "SaveGame|LocalPlayer")
    ENGINE_API void OnPostSave(bool bSuccess);
 
protected:
    ENGINE_API virtual void ProcessSaveComplete(const FString& SlotName, const int32 UserIndex, bool bSuccess, int32 SaveRequest);
 
    static ENGINE_API ULocalPlayerSaveGame* ProcessLoadedSave(USaveGame* BaseSave, const FString& SlotName, const int32 UserIndex, TSubclassOf<ULocalPlayerSaveGame> SaveGameClass, const ULocalPlayer* LocalPlayer);
 
    UPROPERTY(Transient)
    TObjectPtr<const ULocalPlayer> OwningPlayer;
 
    UPROPERTY(Transient)
    FString SaveSlotName;
 
    UPROPERTY()
    int32 SavedDataVersion = 0;
 
    UPROPERTY(Transient)
    int32 LoadedDataVersion = -1;
 
 
    UPROPERTY(Transient)
    int32 CurrentSaveRequest = 0;
 
    UPROPERTY(Transient)
    int32 LastSuccessfulSaveRequest = 0;
 
    UPROPERTY(Transient)
    int32 LastErrorSaveRequest = 0;
 
};