Retrieving the state of a key press on the specified keyboard

summary

Checks to see if a key is pressed on the specified keyboard. Mr./Ms. displays a string while the spacebar is pressed.

Operating environment

Prerequisites

Operating environment

How to operate Mr./Ms.

substance

To get the press state of a key on the keyboard, use the "Keyboard.GetState" method. You can use this method to get a "KeyboardState" structure that contains the state of a key press.

The "Keyboard.GetState" method is usually used within the "Update" method to ensure that it is retrieved in the game.

Keyboard.GetState method

Gets the status of the current keyboard.

Also, since the obtained KeyboardState is used in the Draw method, the state is maintained in the field.

field

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

Update Method

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

Draw Method

To find out which key is being pressed, you can specify any key in the "KeyboardState.IsKeyDown" method of the retrieved KeyboardState. Specify the value to be passed by selecting it from the "Keys enumeration". To check if it is pressed on the contrary, there is a "KeyboardState.IsKeyUp" method.

// スペースキーが押されている場合は文字を表示する
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 method

Checks to see if the specified key is pressed.

KeyboardState.IsKeyUp method

Checks to see if the specified key has been pressed.

You can use the keyboard not only on your Windows PC, but also on your Xbox 360 and Windows Phone.

All Codes

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);
        }
    }
}