XNAメモ – XNAの機能を使ってセーブする方法(Windows編)

久しぶりの更新です！

今回はXBOXでデバイスを選択し、セーブ、ロードをする手順を紹介して欲しいとのリクエストがあったので、それに関して紹介します。

ただ、現在自分がXBOXでテスト出来る環境が無い為、まずはWindowsでは動作確認出来た物を紹介します（と言っても両方で使用出来るはずなので、ただ単にテストしてないだけです）。

まずはテスト用に保存するクラスを作成します。

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Xml.Serialization;
using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Graphics;
using Microsoft.Xna.Framework.Input;
using Microsoft.Xna.Framework.Storage;
using Microsoft.Xna.Framework.GamerServices;

namespace Save
{
[XmlInclude(typeof(Unit)), XmlInclude(typeof(Player))]
public class GameObject
{
public Vector3 Position { get; set; }
}

public class Unit : GameObject
{
public float Life { get; set; }
}

public class Player : GameObject
{
public string Name { get; set; }
}

今回はセーブデータをxml形式で保存します。その際、作ったクラスを保存する為にGameObjectクラスの宣言部分にXmlIncludeを追加しています。

次に実際にセーブするデータを保存するクラスを宣言します。内容はテスト用に適当に詰めたので、必要に応じて変更してください。

public class SaveGameData
{
public string PlayerName;
public Vector2 AvatarPosition;
public int Level;
public int Score;
public List<GameObject> GameObjects;
}

下準備が出来たので、実際にセーブ関連の実装を始めます。

今回はセーブだけを紹介しますが、ロードを実装する時と途中まで処理が一緒なので（実際にデータを扱う所までは同じです）、元となるクラスを実装した後に、それを継承したセーブ用クラスを作成します。

XNA（XBOX）でセーブデータを扱う際、以下の手順が必要です：
– 保存先、もしくは読込先、のデバイスの選択（と獲得）
– 保存先、もしくは読込先、のコンテナの選択（と獲得）
– 選択先のデバイス＋コンテナへのファイル操作

Windowsで実行する場合デバイスは勝手に選択され、セーブデータはマイドキュメント上に作成されます（自分の場合は「SavedGames」と言う名前のフォルダが作成され、保存されていました）。

なのでまず、これらのステップを表すenumを宣言します。ついでに、変数も記載しておきます。

class SaveDataHandler
{
protected enum States
{
None,                        // 何も無い状態
ReadyToSelectStorageDevice,  // デバイス選択を出来る状態
SelectingStorageDevice,      // デバイス選択中
ReadyToOpenStorageContainer, // コンテナをあける準備が出来た状態
OpeningStorageContainer,     // コンテナを開いている最中
HandlingFile                 // ファイル操作中
}

protected StorageDevice m_storageDevice;
protected States m_state;
protected IAsyncResult m_asyncResult;
protected StorageContainer m_storageContainer;
protected PlayerIndex m_controller;
protected string m_filename;    // 保存されるファイル名
protected string m_diplayName;  // 使用されるコンテナ（ディレクトリ）名
protected SaveGameData m_data;

public SaveDataHandler()
{
m_data = null;
m_state = States.None;
m_storageContainer = null;
m_storageDevice = null;
m_filename = "";
m_diplayName = "";
}

public SaveGameData Data
{
get { return m_data; }
set { m_data = value; }
}

次に更新処理です。更新処理内では、先ほど宣言したenumを使って現在の状態を記録し、ソレに応じて違う処理を行います。

まずは、デバイス選択を始める前の処理です。

public void Update(float delta)
{
switch (m_state)
{
case States.ReadyToSelectStorageDevice:
#if XBOX
if (!Guide.IsVisible)
#endif
{
// デバイス選択を表示（Windowだと表示されない)
m_asyncResult = StorageDevice.BeginShowSelector(m_controller, null, null);
m_state = States.SelectingStorageDevice;
}
break;

GuidはXBOX用の処理なので、Windows版では出ないように#if処理を付けています。

次にデバイスを選択する処理です。デバイス選択が終わったら、次に進む処理を実装しています。

case States.SelectingStorageDevice:
if (m_asyncResult.IsCompleted)
{
// デバイス選択を閉じる（Windowだと表示されない)
m_storageDevice = StorageDevice.EndShowSelector(m_asyncResult);
m_state = States.ReadyToOpenStorageContainer;
}
break;

次は、コンテナを開く準備です。

case States.ReadyToOpenStorageContainer:

if (m_storageDevice == null || !m_storageDevice.IsConnected)
{
// デバイスを獲得出来ていない場合、もしくは接続されていない場合は、選択に戻る
m_state = States.ReadyToSelectStorageDevice;
}
else
{
// 指定されたゲームのコンテナを開く
m_asyncResult = m_storageDevice.BeginOpenContainer(m_diplayName, null, null);
m_state = States.OpeningStorageContainer;
}
break;

次はデバイスと同じく、終了したら次に進む処理を追加します。

case States.OpeningStorageContainer:

if (m_asyncResult.IsCompleted)
{
// コンテナを開いたので、処理を終了させる
m_storageContainer = m_storageDevice.EndOpenContainer(m_asyncResult);
m_state = States.HandlingFile;
}
break;

そしてファイル操作時の処理を実装します。

case States.HandlingFile:

if (m_storageContainer == null)
{
// コンテナを獲得できていない場合、戻る
m_state = States.ReadyToOpenStorageContainer;
}
else
{
try
{
// 継承されたクラスで行われる、ファイル処理
Process(m_data);
}
catch (IOException e)
{
// 問題があった場合
OnError(e.Message);
}
finally
{
// コンテナを破棄し、他も初期化する
m_storageContainer.Dispose();
m_storageContainer = null;
m_state = States.None;
m_filename = "";
m_diplayName = "";
}
}
break;
}
}

protected virtual bool Process(SaveGameData data)
{
return false;
}

protected virtual void OnError(string exceptionMessage)
{
Debug.WriteLine(exceptionMessage);
}

ここで行われるProcess()とOnError()メソッドは、継承先のクラスで実際にセーブ処理や、ロード処理、そしてエラー処理を行います。

今回は面倒だから省きましたが、実装方法がしっくり来ない方は、abstractメソッドに変更する等すると、ましになるかもしれません。

更新処理は実装したので、次は処理を開始する（セーブ時に呼び出す）メソッドを実装します。やっている事は初期化だけです。

public void Start(string fileName, string displayName, SaveGameData data, PlayerIndex controller)
{
// 処理を開始 ＋ 初期化
if (m_state == States.None)
{
m_data = data;
m_filename = fileName;
m_diplayName = displayName;
m_state = States.ReadyToOpenStorageContainer;
m_controller = controller;
}
}

このクラス内でなくても良いのですが、セーブ時用に既存のファイルを削除する処理を最後に追加します。

protected void DeleteExistingData(string fileName)
{
// 指定されたファイルが存在した場合、消去する
if (m_storageContainer.FileExists(fileName))
{
m_storageContainer.DeleteFile(fileName);
}
}

これでこのクラスの実装は終わりです。

では次にセーブ用クラスを実装します。行う事は、Process()メソッドをオーバーライドし、セーブ処理を行うだけです。データ保存には、XmlSerializerを使用します。

class DataSaver : SaveDataHandler
{
public DataSaver()
: base()
{
}

protected override bool Process(SaveGameData data)
{
// 存在するデータを消去
DeleteExistingData(m_filename);

// 保存処理
using (Stream stream = m_storageContainer.CreateFile(m_filename))
{
XmlSerializer serializer = new XmlSerializer(typeof(SaveGameData));
serializer.Serialize(stream, data);
}

return true;
}
}

これでセーブ用クラスの実装は全部終わりました。後は使用するだけです。

SaveGameData saveGameData = new SaveGameData()
{
PlayerName = "Ookumaneko",
AvatarPosition = new Vector2(2, -50),
Level = 10,
Score = 9999999990,
GameObjects = new List<GameObject>(),
};

dataSaver.Start("SaveData1.sav", "TetrangleSaveData", saveGameData, PlayerIndex.One);

以上です。これでマイドキュメント上にファイルが追加されるはずです。

今回は、PC、XBOX両方で出来るだけ同じコードを使用出来る用に、XNAと.Netの機能を主に使用しています。なので、PCに限定してゲームを作る際、データを暗号化していないので、紹介した処理をそのまま使用するのはあまりオススメしていません。

使用したい場合は、何かファイルをバイナリー化したり、暗号化するなど変化を加えてから使用してください。XBOX編はテスト出来たら紹介します（内容はほぼ変わらないと思いますが）。

今回は、内容が長くなった為、説明がざっくりしすぎている所が結構あるので、何時か補足を追加するかもしれません。