ゲームを保存して読み込む

SaveGame オブジェクトの作成

USaveGame クラスは、 Kismet/GameplayStatics.h に宣言される関数の保存およびロードのためにターゲットとして使用されるオブジェクトを設定します。

C++ クラス ウィザード を使って USaveGame をもとに新規クラスを作成することができます。

このサンプルでは、新規の USaveGame クラスは「 UMySaveGame 」と呼びます。これを使用するには、その他の #include ディレクティブの後にゲーム モジュールのヘッダ ファイルに以下の行を追加します。

#include "MySaveGame.h"
#include "Kismet/GameplayStatics.h"

ヘッダ

SaveGame オブジェクトのヘッダファイルの中では、 SaveGame を格納するためのどんな変数でも宣言することができます。

UPROPERTY(VisibleAnywhere, Category = Basic)
FString PlayerName;

#pragma once

#include "GameFramework/SaveGame.h"
#include "MySaveGame.generated.h"

/**
 * 
 */
UCLASS()
class [PROJECTNAME]_API UMySaveGame : public USaveGame
{
    GENERATED_BODY()

    public:

    UPROPERTY(VisibleAnywhere, Category = Basic)
    FString PlayerName;

    UPROPERTY(VisibleAnywhere, Category = Basic)
    FString SaveSlotName;

UPROPERTY(VisibleAnywhere, Category = Basic
    uint32 UserIndex;

    UMySaveGame();
};

ソース

一般に、特定の保存システムにここで設定したい追加機能がない限り、 `SaveGame`オブジェクトのソースファイルは機能するために特定のコードを必要としません

この例では、クラス コンストラクタで SaveSlotName`と UserIndex`の値を定義しているため、他のゲームプレイ クラスでそれらを読み取って使用することができます。

// Copyright 1998-2018 Epic Games, Inc.All Rights Reserved.

#include "[ProjectName].h"
#include "MySaveGame.h"

UMySaveGame::UMySaveGame()
{
    SaveSlotName = TEXT("TestSaveSlot");
    UserIndex = 0;
}

まず、新しい UMySaveGame オブジェクトを取得するために CreateSaveGameObject ( UGameplayStatics ライブラリから) を呼び出します。オブジェクトを取得したら、保存するデータを使って入力します。最後に、 SaveGameToSlot または AsyncSaveGameToSlot を呼び出してデバイスにデータを書き出します。

非同期保存

AsyncSaveGameToSlot はゲームの保存に推奨されるメソッド法です。非同期で実行することにより急なフレーム レートの引きつりを防ぎ、プレイヤーへの通知を減らして幾つかのプラットフォーム上で起こりうる認証問題を回避します。保存処理が完了したら、( FAsyncSaveGameToSlotDelegate のタイプの) デリゲートがスロット名、ユーザー インデックス、成功または失敗を示す bool と一緒に呼び出されます。

if (UMySaveGame* SaveGameInstance = Cast<UMySaveGame>(UGameplayStatics::CreateSaveGameObject(UMySaveGame::StaticClass())))
{
    // Set up the (optional) delegate.
    FAsyncSaveGameToSlotDelegate SavedDelegate;
    // USomeUObjectClass::SaveGameDelegateFunction is a void function that takes the following parameters: const FString& SlotName, const int32 UserIndex, bool bSuccess
    SavedDelegate.BindUObject(SomeUObjectPointer, &USomeUObjectClass::SaveGameDelegateFunction);

    // Set data on the savegame object.
    SaveGameInstance->PlayerName = TEXT("PlayerOne");

    // Start async save process.
    UGameplayStatics::AsyncSaveGameToSlot(SaveGameInstance, SlotNameString, UserIndexInt32, SavedDelegate);
}

同期保存

SaveGameToSlot は、小さな SaveGame 形式、およびポーズ中またはメニュー内でのゲームの保存に十分です。ゲームをすぐに保存して成功または失敗を示す bool を返すので簡単に使用できます。容量が大きいデータの場合、またはプレイヤーがゲーム ワールドとアクティブにインタラクトしている間にゲームを自動保存する場合は、 AsyncSaveGameToSlot の方が適しています。

if (UMySaveGame* SaveGameInstance = Cast<UMySaveGame>(UGameplayStatics::CreateSaveGameObject(UMySaveGame::StaticClass())))
{
    // Set data on the savegame object.
    SaveGameInstance->PlayerName = TEXT("PlayerOne");

    // Save the data immediately.
    if (UGameplayStatics::SaveGameToSlot(SaveGameInstance, SlotNameString, UserIndexInt32))
    {
        // Save succeeded.
    }
}

バイナリ保存

SaveGameToMemory 機能を使って SaveGame オブジェクトをメモリに転送することができます。この関数は同期での操作のみを提供しますが、ドライブへの保存より高速です。呼び出し元はデータが格納されたバッファ ( TArray<uint8>& ) へ参照を提供します。成功した場合は True を返します。

TArray<uint8> OutSaveData;
if (UGameplayStatics::SaveGameToMemory(SaveGameObject, OutSaveData))
{
    // The operation succeeded, and OutSaveData now contains a binary represenation of the SaveGame object.
}

`SaveGameToSlot` 関数と同様に、バッファ (`const TArray<uint8>&`)、スロット名、ユーザー ID 情報を使って `SaveDataToSlot` を呼び出すことでバイナリ データをファイルに直接保存することもできます。`SaveGameToMemory` のように、この関数は同期操作のみ提供し、成功または失敗を示すために `bool` を返します。

if (UGameplayStatics::SaveDataToSlot(InSaveData, SlotNameString, UserIndexInt32))
{
    // The operation succeeded, and InSaveData has been written to the save file defined by the slot name and user ID we provided.
}

非同期的なロード方法

AsyncLoadGameFromSlot で非同期的にロードする場合、システムがロードするデータを受け取るためにコールバック デリゲートを提供しなければなりません。

// Set up the delegate.
FAsyncLoadGameFromSlotDelegate LoadedDelegate;
// USomeUObjectClass::LoadGameDelegateFunction is a void function that takes the following parameters: const FString& SlotName, const int32 UserIndex, USaveGame* LoadedGameData
LoadedDelegate.BindUObject(SomeUObjectPointer, &USomeUObjectClass::LoadGameDelegateFunction);
UGameplayStatics::AsyncLoadGameFromSlot(SlotName, 0, LoadedDelegate);

同期的なロード方法

LoadGameFromSlot 関数は、 USaveGame オブジェクトを作成し、成功した場合に USaveGame オブジェクト返します。

// Retrieve and cast the USaveGame object to UMySaveGame.
if (UMySaveGame* LoadedGame = Cast<UMySaveGame>(UGameplayStatics::LoadGameFromSlot(SlotName, 0)))
{
    // The operation was successful, so LoadedGame now contains the data we saved earlier.
    UE_LOG(LogTemp, Warning, TEXT("LOADED: %s"), *LoadedGame->PlayerName);
}

バイナリ形式のロード方法

LoadDataFromSlot を使ってファイルから SaveGame データを生のバイナリ形式でロードすることができます。この関数は、SaveGame を作成しないという点を除き、 LoadGameFromSlot と非常によく似ています。このロード方法の場合は、同期操作のみ使用できます。

TArray<uint8> OutSaveData;
if (UGameplayStatics::LoadDataFromSlot(OutSaveData, SlotNameString, UserIndexInt32))
{
    // The operation succeeded, and OutSaveData now contains a binary represenation of the SaveGame object.
}

You can also convert this binary data to a SaveGame object by calling`LoadGameFromMemory を呼び出すことで、このバイナリ データを SaveGame オブジェクトに変換することもできます。これは同期呼び出しで、成功すると新しい USaveGame` オブジェクトを、失敗すると null ポインタを返します。

if (UMySaveGame* SaveGameInstance = Cast<UMySaveGame>(LoadGameFromMemory(InSaveData)))
{
    // The operation succeeded, and SaveGameInstance was able to cast to type we expected (UMySaveGame).
}