【Unity】RPGを作るチュートリアルその36 ゲーム内のキー入力のラッパークラス

シンプルなRPGをUnityで作るチュートリアルシリーズの36回目です。

第35回ではデバッグ用の機能としてログのラッパークラスを作成しました。

今回はゲーム内のキー入力を検知するためのラッパークラスを追加します。PC向けのゲームの場合、決定キーやキャンセルキーの役割を担うキーが複数あったりするので、その部分をまとめて検知する仕組みを用意したいと思います。

制作環境

MacBook Pro 2023 Apple M2 Max

Unity6 (6000.0.30f1) Silicon

作業内容と順序

シンプルなRPGを作る上でどんな作業が必要か、どんな順番で作っていくと良さそうか、別ページで検討しました。基本的にこの流れに沿って進めていきます。

エクスプラボ

【Unity】簡単なRPGを作る場合に必要な作業を考えてみよう

https://ekulabo.com/simple-rpg-ready

UnityでRPGを作るときに必要になるであろう作業をリストアップしてみました。抜け漏れがない形ではなく、さっと思いついた部分をまとめているので、実際に作業してみて追加を行う部分もあるかもしれません。

エクスプラボ

UnityでRPGを作る時にスムーズにいきそうな作業順序を考えてみる

https://ekulabo.com/unity-rpg-work-flow

シンプルなRPGを作ることを想定して、スムーズに進みそうな作業順序を考えてみました。個人個人でやりやすい進め方も異なるかと思いますので、ひとつのサンプルとして捉えていただければと思います。

チュートリアルの一覧

このシリーズ全体の一覧は以下のページにまとめています。

エクスプラボ

 

1 User

1 Pocket

【Unity】シンプルなRPGを作るチュートリアルの一覧まとめ

https://ekulabo.com/rpg-tutorial-list

UnityでシンプルなRPGを作るチュートリアルシリーズのまとめページです。もし個別のページからご覧いただいた場合は、こちらのまとめページもご参照ください。

前回の内容

前回はデバッグ用の機能としてログのラッパークラスを作成しました。

エクスプラボ

 

1 Pocket

【Unity】RPGを作るチュートリアルその35 デバッグ用ログのラッパークラス

https://ekulabo.com/rpg-tutorial-debug-log-wrapper

UnityでシンプルなRPGを作るチュートリアルシリーズの第35回です。この回では戦闘機能の作成に入る前に、デバッグ用の機能としてログのラッパークラスを作成したいと思います。UnityのDebugクラスを使う方法も良いかと思いますが、ログのメッセージにプレフィックスをつけることで、Unityデフォルトのログなのか、自分が仕込んだログなのかを区別しやすくしたいと思います。また、一括でログの出力を止める機能もつけたいと思います。

キー入力のラッパークラス

PC向けのゲームの場合、同じ役割を持ったキーが複数あることもあります。例えば決定の役割だと、エンターキー、スペースキー、Zキー、と複数のキーで同じ役割を担っていることが多いかと思います。キャンセルの役割なら、EscキーとXキーがよく使われるかと思います。

こうしたキーの入力を検知するために、毎回各クラスの中で複数キーの入力を確認するのは大変なので、複数のキー入力を確認できるラッパークラスを用意して、そこでいずれかのキー入力があったかどうかを確認します。具体的には、Input.GetKeyDown()を使って、「||」で繋いで該当のキー入力の有無を返したいと思います。

InputのGetKeyUpを使うか、GetKeyDownを使うかは悩む点ですが、スマホ向けだと指を離したタイミングで検知したいのでGetKeyUp、PCやコンソール向けだとキーを押したタイミングで検知したいのでGetKeyDownを使うのが良いかと思います。スマホの場合、指をずらすことでボタンのタップを回避できることからUpの方がよく使われているように思います。PCやコンソールだと、ボタンを離して回避が難しいため、押した瞬間に反応した方が直感的かもしれません。

決定キー、キャンセルキー、方向キーで複数のキーを持たせることが多いですが、今回は決定キーとキャンセルキーを対象にしたいと思います。方向キーは矢印キーを使う方向で進めましょう。

キーの定義

一般的なキー配置を踏襲し、決定ボタンはエンターキー、スペースキー、Zキーを対象にします。

キャンセルボタンはEscキーとXキーを対象にします。

キー入力のラッパークラスの作成

Projectウィンドウの「Assets/Scripts」のフォルダにて、空のスクリプトを作成します。名前は [InputGameKey] にしました。

作成した「InputGameKey」の中身は以下のように記載しました。

決定ボタンの役割を持つキーをまとめたのが「ConfirmButton()」のメソッドで、キャンセルボタンの役割を持つキーをまとめたのが「CancelButton()」のメソッドです。

これらのメソッドをUpdate()のタイミングで呼ぶことによって、いずれかのキー入力を検知します。毎回「Input.GetKeyDown」と書かなくて良くなるので楽になるかと思います。また、「やっぱりキャンセルキーにあれも追加しておこう！」となったときに、キャンセルの処理を書いている全部のクラスの改修を行わなくて済みます。

今回は対象外ですが、キーコンフィグの機能がある場合は、コンフィグ用の設定ファイルを読み込んで、そのキーを検知する形にするのが良いかと思います。

動作確認

既存のクラス、あるいはテスト用に作ったクラスのUpdate()などから「InputGameKey」のメソッドを呼び出して、ログとして出力するようにしてみます。この状態でゲームを実行し、確認を行ってみます。

前回と同様に私は「PlayerMover」を使って、Update()に処理を書きました。これは後ほど消すので、githubのリポジトリでは(おそらく)含まれません。

ゲームの実行中に決定キーに対応するキーや、キャンセルキーに対応するキーを押すと以下のようにログが出力されます。決定キーの中でエンターキー、スペースキー、Zキーのどれが押されたとしても同様にログが出てきます。

キーの操作とログの出力の対応が確認できたら、テスト用の処理を削除して今回は終了です。

今回のブランチ

GitHub

Build software better, together

https://github.com/todorok1/SimpleRPGTutorial/tree/tutorial-36

GitHub is where people build software. More than 150 million people use GitHub to discover, fork, and contribute to over 420 million projects.

まとめ

今回はゲーム内のキー入力を検知するためのラッパークラスを作成しました。同じ機能を持ったキーの入力確認を1箇所にまとめておくことで管理もしやすくなります。

次回はいよいよ戦闘の機能全体を管理するクラスを作成していきます。作成するクラスの繋がりを確認しつつ、まずは管理クラスの枠組みだけ作っていきましょう。

エクスプラボ

 

1 Pocket

【Unity】RPGを作るチュートリアルその37 戦闘機能全体の管理クラス

https://ekulabo.com/rpg-tutorial-battle-manager

UnityでシンプルなRPGを作るチュートリアルシリーズの第37回です。この回ではいよいよ戦闘の機能全体を管理するクラスを作成していきます。作成するクラスの繋がりを確認しつつ、まずは管理クラスの枠組みだけ作っていきましょう。