指定したキーボードのキーの押下状態取得

Page updated :

The page you are currently viewing does not support the selected display language.

概要

指定したーキーボードのキーが押されているかを調べます。サンプルではスペースキーが押されている間、文字列が表示されます。

指定したキーボードのキーの押下状態取得

動作環境

必須環境

対応 XNA バージョン
  • 2.0
  • 3.0
  • 3.1
  • 4.0
対応プラットフォーム
  • Windows (XP SP2 以降, Vista, 7)
  • Xbox 360
  • Windows Phone 7
Windows 必須頂点シェーダ バージョン 2.0
Windows 必須ピクセルシェーダ バージョン 2.0

動作確認環境

プラットフォーム
  • Windows 7
  • Xbox 360
  • Windows Phone 7 エミュレーター

サンプルの操作方法

動作 キーボード Xbox 360 コントローラー マウス タッチ
押下チェック Space - - -

内容

キーボードのキーの押下状態を取得するには「Keyboard.GetState」メソッドを使用します。このメソッドを使用するとキーの押下状態を格納した「KeyboardState」構造体を取得することができます。

「Keyboard.GetState」メソッドはゲーム中で確実に取得できるように「Update」メソッド内で使用するのが普通です。

Keyboard.GetState メソッド

カレントキーボードの状態を取得します。

戻り値 KeyboardState カレントキーボードの状態を「KeyboardState」構造体で取得します

また、取得した KeyboardState は Draw メソッドで使用するのでフィールドどして状態を保持するようにしています。

フィールド

/// <summary>
/// キーボードの状態
/// </summary>
private KeyboardState keyState = Keyboard.GetState();

Update メソッド

// キーボードの状態を取得
this.keyState = Keyboard.GetState();

Draw メソッド

どのキーが押されているかを調べるには、取得した KeyboardState の「KeyboardState.IsKeyDown」メソッドに任意のキーを指定して調べることができます。渡す値は「Keys 列挙」から選んで指定します。逆に押されていないかを調べるには「KeyboardState.IsKeyUp」メソッドがあります。

// スペースキーが押されている場合は文字を表示する
if (this.keyState.IsKeyDown(Keys.Space))
{
    this.spriteBatch.DrawString(this.font, "A space key is being pressed.",
        new Vector2(50.0f, 80.0f), Color.Yellow);
}

KeyboardState.IsKeyDown メソッド

指定したキーが押されているかを調べます。

key Keys 調べるキーを Keys 列挙から指定します。
戻り値 bool キーが押されているなら true、押されていないなら false を返します。

KeyboardState.IsKeyUp メソッド

指定したキーが押されていないかを調べます。

key Keys 調べるキーを Keys 列挙から指定します。
戻り値 bool キーが押されているなら false、押されていないなら true を返します。

キーボードは Windows PC だけでなく、Xbox 360、Windows Phone でも使うことができます。

全コード

using System;
using System.Collections.Generic;
using System.Linq;
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.Media;
#if WINDOWS_PHONE
using Microsoft.Xna.Framework.Input.Touch;
#endif

namespace PressedKeyboard
{
    /// <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 KeyboardState keyState = Keyboard.GetState();


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

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

#if WINDOWS_PHONE
            // Windows Phone のデフォルトのフレームレートは 30 FPS
            this.TargetElapsedTime = TimeSpan.FromTicks(333333);

            // バックバッファサイズの設定
            this.graphics.PreferredBackBufferWidth = 480;
            this.graphics.PreferredBackBufferHeight = 800;

            // フルスクリーン表示
            this.graphics.IsFullScreen = true;
#endif
        }

        /// <summary>
        /// ゲームが始まる前の初期化処理を行うメソッド
        /// グラフィック以外のデータの読み込み、コンポーネントの初期化を行う
        /// </summary>
        protected override void Initialize()
        {
            // TODO: ここに初期化ロジックを書いてください

            // コンポーネントの初期化などを行います
            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)
        {
            // Xbox 360 コントローラ、Windows Phone の BACK ボタンを押したときに
            // ゲームを終了させます
            if (GamePad.GetState(PlayerIndex.One).Buttons.Back == ButtonState.Pressed)
            {
                this.Exit();
            }

            // キーボードの状態を取得
            this.keyState = Keyboard.GetState();

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

        /// <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, "Please press a space key.",
               new Vector2(50.0f, 50.0f), Color.White);

            // スペースキーが押されている場合は文字を表示する
            if (this.keyState.IsKeyDown(Keys.Space))
            {
                this.spriteBatch.DrawString(this.font, "A space key is being pressed.",
                    new Vector2(50.0f, 80.0f), Color.Yellow);
            }

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

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