ストレージコンテナのパスを取得する

概要

選択したストレージデバイスのストレージコンテナパスを取得します。

動作環境

必須環境

動作確認環境

サンプルの操作方法

内容

ストレージデバイス選択UIについて

Xbox 360 にはハードディスクやメモリーユニットなど複数のデータ保存デバイスが存在します。ゲームなどでデータを保存する場合に、どのデバイスに保存するのかを選択する UI(ユーザーインターフェース)が Xbox 360 に標準で備わっています。(上図参照)

今回のサンプルではこの UI を使用して保存先パスを取得しています。

ゲームサービスコンポーネントの追加

保存デバイス選択 UI は実際のゲームとは非同期で動作します。これを実現させるにはゲームサービスを追加し、ゲームサービスによって保存デバイス選択 UI を動作させる必要があります。

// 非同期処理を行うためのゲームサービスコンポーネントを追加
this.Components.Add(new GamerServicesComponent(this));

GamerServicesComponent コンストラクタ

ゲーマーサービスの処理を行う GamerServicesComponent のインスタンスを作成します。

ストレージデバイス選択 UI の表示開始

保存デバイス選択 UI を表示させるには Update メソッド内で「Guide.BeginShowStorageDeviceSelector」メソッドを呼びます。ただし、保存デバイス選択 UI はこのメソッドを呼んだ時点では表示されず、先ほど追加したゲームサービスによって呼ばれる形になります。

「Guide.BeginShowStorageDeviceSelector」メソッドの第1引数には、保存デバイス選択 UI でデバイス選択後に呼ばれるメソッドを指定します。このメソッドは独自に定義する必要があります(次のセクション参照)。

第2引数には任意のデータを設定できます。保存デバイスを選択した後に何らかのデータを使用したい場合はこの引数に独自データを設定します。

// ストレージデバイス選択UIを表示するための設定を行います
Guide.BeginShowStorageDeviceSelector(this.GetStorageDevice, null);

Guide.BeginShowStorageDeviceSelector メソッド

ストレージデバイス選択 UI を表示するためのプロセスを開始します。この操作はゲームプロセスとは非同期で行われます。

ちなみにこの保存デバイス選択 UI はデバイスがひとつしか接続されていない場合は自動的に選択されるため表示されません。また Windows の場合も表示されません。

ストレージデバイス選択後の処理メソッド

Guide.BeginShowStorageDeviceSelector メソッドに指定するメソッドは IAsyncResult を受け取れるように定義します。

/// <summary>
/// ストレージデバイスを取得するために呼ばれる
/// </summary>
/// <param name="result">非同期処理の結果</param>
private void GetStorageDevice(IAsyncResult result)
{
    // 結果をもとにストレージデバイスの選択UIを終了してストレージデバイスを取得します
    StorageDevice storageDevice = Guide.EndShowStorageDeviceSelector(result);

    if (storageDevice != null && storageDevice.IsConnected)
    {
        ///// ストレージデバイスの取得に成功し、接続されている場合 /////

        // ストレージコンテナを開きます
        using (StorageContainer container = storageDevice.OpenContainer("XNASample"))
        {
            // コンテナの名前を取得
            this.storageContainerName = container.TitleName;

            // コンテナで指定されているパスを取得
            this.storageContainerPath = container.Path;
        }
    }
}

保存デバイス選択 UI でデバイス選択処理を終えるとこのメソッドが呼ばれます。

引数によって渡された結果(IAsyncResult)を「Guide.EndShowStorageDeviceSelector」の引数に渡すことによって保存デバイスを受け取ることができます。 もし選択をキャンセルした場合は null が返される点に注意してください。

Guide.EndShowStorageDeviceSelector メソッド

保存デバイス選択 UI の表示をおわらせ、保存デバイスを受け取ります。

実際にデバイスが接続されているかを「StorageDevice.IsConnected」プロパティで確認し、「StorageDevice.OpenContainer」メソッドでコンテナを開きます。StorageDevice.OpenContainer メソッドの引数にはコンテナの名前を指定します。この名前によってデータを保存するコンテナを識別します。

StorageDevice.IsConnected プロパティ

デバイスが正常に接続されている場合は true、それ以外は false を返します。

StorageDevice.OpenContainer メソッド

指定した名前のストレージコンテナを開きます。

コンテナを取得したら、「StorageContainer.Path」プロパティでファイルの保存先パスを取得できます。

StorageContainer.Path プロパティ

ユーザーのゲーム保存ファイルのファイルパスを取得します。

ストレージデバイス選択 UI は非同期処理であることを考慮する

サンプルでは保存デバイス選択 UI が表示されている間、非同期で実行されていることを確認するために、毎フレームカウントを行いカウント数を表示しています。実際に動作させてみると、デバイス選択 UI が表示されている間でもバックでカウンターの値が増えていることがわかります。

実際にゲームを作る場合はこの点も考慮し、デバイス選択中はゲームの進行を止めるように考慮しなければいけません。または、進行は止めるがエフェクトなどの画面効果は継続させる、という方法もあるかもしれません。この辺は実際のゲームに合わせて調整する必要があります。

全コード

using System;
using System.Collections.Generic;
using System.IO;
using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Audio;
using Microsoft.Xna.Framework.Content;
using Microsoft.Xna.Framework.GamerServices;
using Microsoft.Xna.Framework.Graphics;
using Microsoft.Xna.Framework.Input;
using Microsoft.Xna.Framework.Net;
using Microsoft.Xna.Framework.Storage;

namespace GetStorageContainerPath
{
    /// <summary>
    /// ゲームメインクラス
    /// </summary>
    public class GameMain : Microsoft.Xna.Framework.Game
    {
        /// <summary>
        /// グラフィックデバイス管理クラス
        /// </summary>
        private GraphicsDeviceManager graphics = null;

        /// <summary>
        /// スプライトのバッチ化クラス
        /// </summary>
        private SpriteBatch spriteBatch = null;

        /// <summary>
        /// スプライトでテキストを描画するためのフォント
        /// </summary>
        private SpriteFont font = null;

        /// <summary>
        /// ストレージコンテナの名前
        /// </summary>
        private string storageContainerName = "";

        /// <summary>
        /// ストレージコンテナのパス
        /// </summary>
        private string storageContainerPath = "";

        /// <summary>
        /// フレームカウント数
        /// </summary>
        private int frameCount = 0;

        /// <summary>
        /// 直線のキーボード入力の状態
        /// </summary>
        private KeyboardState oldKeyboardState = new KeyboardState();

        /// <summary>
        /// 直線のゲームパッド入力の状態
        /// </summary>
        private GamePadState oldGamePadState = new GamePadState();


        /// <summary>
        /// GameMain コンストラクタ
        /// </summary>
        public GameMain()
        {
            // グラフィックデバイス管理クラスの作成
            this.graphics = new GraphicsDeviceManager(this);

            // ゲームコンテンツのルートディレクトリを設定
            this.Content.RootDirectory = "Content";

            // 画面サイズを変更
            this.graphics.PreferredBackBufferWidth = 1024;
            this.graphics.PreferredBackBufferHeight = 768;

            // 非同期処理を行うためのゲームサービスコンポーネントを追加
            this.Components.Add(new GamerServicesComponent(this));
        }

        /// <summary>
        /// ゲームが始まる前の初期化処理を行うメソッド
        /// グラフィック以外のデータの読み込み、コンポーネントの初期化を行う
        /// </summary>
        protected override void Initialize()
        {
            // コンポーネントの初期化などを行います
            base.Initialize();
        }

        /// <summary>
        /// ゲームが始まるときに一回だけ呼ばれ
        /// すべてのゲームコンテンツを読み込みます
        /// </summary>
        protected override void LoadContent()
        {
            // テクスチャーを描画するためのスプライトバッチクラスを作成します
            this.spriteBatch = new SpriteBatch(this.GraphicsDevice);

            // フォントをコンテンツパイプラインから読み込む
            this.font = this.Content.Load<SpriteFont>("Font");
        }

        /// <summary>
        /// ゲームが終了するときに一回だけ呼ばれ
        /// すべてのゲームコンテンツをアンロードします
        /// </summary>
        protected override void UnloadContent()
        {
            // TODO: ContentManager で管理されていないコンテンツを
            //       ここでアンロードしてください
        }

        /// <summary>
        /// 描画以外のデータ更新等の処理を行うメソッド
        /// 主に入力処理、衝突判定などの物理計算、オーディオの再生など
        /// </summary>
        /// <param name="gameTime">このメソッドが呼ばれたときのゲーム時間</param>
        protected override void Update(GameTime gameTime)
        {
            // キーボードの情報取得
            KeyboardState keyboardState = Keyboard.GetState();

            // ゲームパッドの情報取得
            GamePadState gamePadState = GamePad.GetState(PlayerIndex.One);

            // Xbox360 コントローラの BACK ボタンを押したときにゲームを終了させます
            if (gamePadState.Buttons.Back == ButtonState.Pressed)
            {
                this.Exit();
            }

            if ((keyboardState.IsKeyDown(Keys.A) && this.oldKeyboardState.IsKeyUp(Keys.A)) ||
                (gamePadState.Buttons.A == ButtonState.Pressed &&
                    this.oldGamePadState.Buttons.A == ButtonState.Released))
            {
                ///// A ボタンが押されたとき /////

                // ストレージデバイス選択UIを表示するための設定を行います
                Guide.BeginShowStorageDeviceSelector(this.GetStorageDevice, null);
            }

            // 入力情報を記憶
            this.oldKeyboardState = keyboardState;
            this.oldGamePadState = gamePadState;

            // フレームのカウント
            this.frameCount++;

            // 登録された GameComponent を更新する
            base.Update(gameTime);
        }

        /// <summary>
        /// ストレージデバイスを取得するために呼ばれる
        /// </summary>
        /// <param name="result">非同期処理の結果</param>
        private void GetStorageDevice(IAsyncResult result)
        {
            // 結果をもとにストレージデバイスの選択UIを終了してストレージデバイスを取得します
            StorageDevice storageDevice = Guide.EndShowStorageDeviceSelector(result);

            if (storageDevice != null && storageDevice.IsConnected)
            {
                ///// ストレージデバイスの取得に成功し、接続されている場合 /////

                // ストレージコンテナを開きます
                using (StorageContainer container = storageDevice.OpenContainer("XNASample"))
                {
                    // コンテナの名前を取得
                    this.storageContainerName = container.TitleName;

                    // コンテナで指定されているパスを取得
                    this.storageContainerPath = container.Path;
                }
            }
        }

        /// <summary>
        /// 描画処理を行うメソッド
        /// </summary>
        /// <param name="gameTime">このメソッドが呼ばれたときのゲーム時間</param>
        protected override void Draw(GameTime gameTime)
        {
            // 画面を指定した色でクリアします
            this.GraphicsDevice.Clear(Color.CornflowerBlue);

            // スプライトの描画準備
            this.spriteBatch.Begin();

            // テキスト描画
            this.spriteBatch.DrawString(this.font,
                "A : Data is saved in a file.",
                new Vector2(50.0f, 50.0f), Color.White);

            // ストレージコンテナの名前
            this.spriteBatch.DrawString(this.font,
                "StorageContainerTitleName : " + this.storageContainerName,
                new Vector2(50.0f, 70.0f), Color.White);

            // ストレージコンテナのパス
            this.spriteBatch.DrawString(this.font,
                "[ Path ]\r\n" + this.storageContainerPath,
                new Vector2(50.0f, 90.0f), Color.White);

            // フレームカウント
            this.spriteBatch.DrawString(this.font,
                "FrameCount : " + this.frameCount,
                new Vector2(this.graphics.PreferredBackBufferWidth - 200.0f, 50.0f), Color.White);

            // スプライトの一括描画
            this.spriteBatch.End();

            // 登録された DrawableGameComponent を描画する
            base.Draw(gameTime);
        }
    }
}