【初心者向け】Input System の実装例

はじめに

　Unity の新 Input System は高機能ですが、【仕組みが難しい】【情報が断片的】【公式サンプルが大規模すぎる】といった理由で、初心者が挫折しやすい内容です。
特に従来の InputManager に比べると難しい内容になっています。

　この記事では、初心者が最短で「実用的な操作入力」を実装できる構成をベースに、後半で Generate C# を使った拡張設計まで段階的に解説します。

　なお、こちらのサイトが非常に丁寧かつ、わかりやすいのでおすすめです。

　　=>　ねこじゃらシティ様【Unity】Input Systemの使い方入門

初心者におすすめの入力設計方針

　結論からいうと、公式で解説しているコールバックを利用するよりも、
InputActionReference アセットをアサインして、直接入力を読む方式が初心者の方にはわかりやすいです。

　理由は以下の通りです。

・Update で入力 → 処理という直感的構造
・デバッグが容易
・キーカスタマイズが非常に簡単
・旧 InputManager と発想が近い

基本構成（InputActionReference方式）

①Input Actions アセット作成

　こちらは InputSystem のデフォルト設定のものを利用しても問題ありません。

　自作していく場合には、Assets → Create → Input Actions で制作してください。

　ActionMap 構成例です。

Player
　├ Move (Value / Vector2)
　├ Jump (Button)
　├ Dash (Button)

②InputActionReference 作成

　こちらも InputSystem の初期設定をそのまま利用して問題ありません。

③入力感知デバッグ用スクリプト作成

　入力感知を行うための、デバッグ用スクリプトとして PlayerInputHandler スクリプトを作成します。

　こちらでは InputActionReference 型をアサインし、各 Action から入力を受け付けられる状態を作っています。

PlayerInputHandler.cs

←クリックすると開きます。

using UnityEngine;
using UnityEngine.InputSystem;

public class PlayerInputHandler : MonoBehaviour
{
    [Header("Input Actions")]
    [SerializeField] private InputActionReference move;
    [SerializeField] private InputActionReference jump;
    [SerializeField] private InputActionReference dash;


    private void OnEnable()
    {
        move.action.Enable();
        jump.action.Enable();
        dash.action.Enable();
    }

    private void OnDisable()
    {
        move.action.Disable();
        jump.action.Disable();
        dash.action.Disable();
    }

    private void Update()
    {
        HandleMove();
        HandleJump();
        HandleDash();
    }

    void HandleMove()
    {
        Vector2 input = move.action.ReadValue<Vector2>();
        Debug.Log($"Move: {input}");
    }

    void HandleJump()
    {
        if (jump.action.triggered)
        {
            Debug.Log("Jump!");
        }
    }

    void HandleDash()
    {
        if (dash.action.triggered)
        {
            Debug.Log("Dash!");
        }
    }
}

　こちらを任意のゲームオブジェクトにアタッチし、各 InputActionReference をアサインした上でゲームを実行します。
そしてキー入力を行い、Console ビューにデバッグログが表示されるかを確認してください。

この方式のメリット

　InputSystem を利用するにあたり、InputActionReference を活用するメリットです。

項目	内容
学習コスト	非常に低い
デバッグ	Update 内で追える
キー変更	アセット変更だけ(プログラムの変更不要)
再利用	Prefab化可能
可読性	非常に高い

　InputSystem 最大の利点は【キー設定をデータ(アセット)側で完結できる = プログラムの変更が不要】という点です。

　WASD → 矢印キー → ゲームパッド

　すべて InputAction 側の Binding を変更するだけです。

なぜ Generate C# があるのか？

　InputAction アセットのインスペクターには Generate C# Class というチェックボックスがあります。

　こちらはイベント駆動型の仕組みを実装するためのものです。
コールバック方式により、指定のメソッドがイベントとして実行され、引数として入力値を受け取る方式です。

　ですが、初心者向けには難しい内容となっていますので、まずは InputActionReference 型をアサインする方式に慣れておき、
InputSystem の仕組みをある程度理解できてから実装を行った方がわかりやすいと思います。

①生成される構造イメージ

　Input Actions アセット → Inspector 内の Generate C# Class にチェックを入れます。

　各項目を入力する場所が表示されます。

　C# Class File の右端の … を押すと、新しく InputAciton 用のスクリプトが自動生成されます。
クラス名は任意です。

②サンプルスクリプト

　下記は C# Class File で自動生成された PlayerControls スクリプトを利用し、
キー入力をコールバック(イベント)方式で受け取って動かすタイプのサンプルコードです。

public class PlayerInputHandler : MonoBehaviour
{
    private PlayerControls controls;

    void Awake()
    {
        controls = new PlayerControls();

        controls.Player.Move.performed += ctx => OnMove(ctx);
        controls.Player.Jump.performed += ctx => OnJump();
    }

    void OnEnable() => controls.Enable();
    void OnDisable() => controls.Disable();

    void OnMove(InputAction.CallbackContext ctx)
    {
        Vector2 input = ctx.ReadValue<Vector2>();
        Debug.Log($"Move: {input}");
    }

    void OnJump()
    {
        Debug.Log("Jump!");
    }
}

③InputActionReference方式との設計的違い

Reference方式

MonoBehaviour
  └ InputActionReference → action.ReadValue()

Generate C#方式

Input管理クラス
  └ PlayerControls → ActionMap → イベント

　このように、完全に「入力管理システム」として分離できるのが Generate C# を使うメリットとポイントになります。

④注意点

　InputSystem は OnEnable メソッドなどを利用して、controls.Enable(); のように明示的に InputAction の起動を行う必要があります。
これは InputActionReference を利用する場合も同じです。

　アサインして、コールバックメソッドを作成しただけでは動きませんので注意してください。

void Awake()
{
    controls = new PlayerControls();
    controls.Newactionmap.AddCallbacks(this);
}

void OnEnable()
{
    controls.Enable();
}

void OnDisable()
{
    controls.Disable();
}

　このようにライフサイクルを作る必要があります。

２Ｄ横スクロール用　プレイヤー移動処理のサンプルコード

　InputSystem + Rigidbody2D を利用した、スーパーマリオのような２Ｄ横スクロール(プラットフォーマー)用のプレイヤーの移動処理のサンプルコードです。
３Ｄについてはカメラの回転をプレイヤーの方向に反映する必要がありますので、別記事にて紹介しています。

　　→　【Unity 6000 版】キャラクターの移動とカメラの回転機能
　

PlayerPlatformerController.cs

←　クリックすると開きます。

using UnityEngine;
using UnityEngine.InputSystem;

/// <summary>
/// 2D横スクロール用 プレイヤー移動制御
/// ・Input System による入力取得
/// ・Rigidbody2D による物理移動
/// ・左右移動、ジャンプ、自然落下
/// </summary>
[RequireComponent(typeof(Rigidbody2D))]
public class PlayerPlatformerController : MonoBehaviour
{
    // ------------------------------
    // 移動関連
    // ------------------------------

    [Header("Movement Settings")]
    [Tooltip("歩行スピード")]
    public float walkSpeed = 5f;

    [Tooltip("ダッシュ時のスピード")]
    public float runSpeed = 8f;

    // ------------------------------
    // ジャンプ・重力
    // ------------------------------

    [Header("Jump & Gravity")]
    [Tooltip("ジャンプ力")]
    public float jumpPower = 12f;

    [Tooltip("接地判定用 Layer")]
    public LayerMask groundLayer;

    [Tooltip("接地判定 半径")]
    public float groundCheckRadius = 0.15f;

    [Tooltip("接地判定用 Transform")]
    public Transform groundCheckPoint;

    // ------------------------------
    // 内部変数
    // ------------------------------

    private Rigidbody2D rb;
    private Vector2 moveInput;
    private bool isGrounded;

    // Input System
    [SerializeField] private InputActionReference move;
    [SerializeField] private InputActionReference jump;
    [SerializeField] private InputActionReference run;

    // ------------------------------
    // 初期化
    // ------------------------------

    private void Awake()
    {
        TryGetComponent(out rb);
    }

    private void OnEnable()
    {
        move.action.Enable();
        jump.action.Enable();
        run?.action.Enable();
    }

    private void OnDisable()
    {
        move.action.Disable();
        jump.action.Disable();
        run?.action.Disable();
    }

    // ------------------------------
    // 更新
    // ------------------------------

    private void Update()
    {
        UpdateGroundedState();     // ① 接地判定
        UpdateMoveInput();         // ② 入力取得
        UpdateHorizontalMovement();// ③ 左右移動
        ApplyJump();               // ④ ジャンプ
    }

    // ------------------------------
    // 接地判定
    // ------------------------------

    private void UpdateGroundedState()
    {
        isGrounded = Physics2D.OverlapCircle(
            groundCheckPoint.position,
            groundCheckRadius,
            groundLayer
        );
    }

    // ------------------------------
    // 入力取得
    // ------------------------------

    private void UpdateMoveInput()
    {
        moveInput = move.action.ReadValue<Vector2>();
    }

    // ------------------------------
    // 左右移動
    // ------------------------------

    private void UpdateHorizontalMovement()
    {
        float speed = run != null && run.action.IsPressed()
            ? runSpeed
            : walkSpeed;

        rb.velocity = new Vector2(moveInput.x * speed, rb.velocity.y);

        // 向き反転（スプライト用）
        if (Mathf.Abs(moveInput.x) > 0.01f)
        {
            Vector3 scale = transform.localScale;
            scale.x = Mathf.Sign(moveInput.x) * Mathf.Abs(scale.x);
            transform.localScale = scale;
        }
    }

    // ------------------------------
    // ジャンプ
    // ------------------------------

    private void ApplyJump()
    {
        if (jump.action.triggered && isGrounded)
        {
            rb.velocity = new Vector2(rb.velocity.x, jumpPower);
        }
    }

    // ------------------------------
    // デバッグ表示
    // ------------------------------

    private void OnDrawGizmosSelected()
    {
        if (groundCheckPoint == null) return;

        Gizmos.color = Color.yellow;
        Gizmos.DrawWireSphere(groundCheckPoint.position, groundCheckRadius);
    }
}

２Ｄトップダウン用　プレイヤー移動処理のサンプルコード

　　InputSystem + Rigidbody2D を利用した、初代ゼルダの伝説のような上から見下ろした視点(トップダウン)のプレイヤーの移動処理のサンプルコードです。

PlayerTopDown2DController.cs

←　クリックすると開きます。

using UnityEngine;
using UnityEngine.InputSystem;

/// <summary>
/// トップダウン2D（見下ろし視点）用 プレイヤー移動制御
/// ・初代ゼルダの伝説 型操作
/// ・重力なし
/// ・上下左右 移動
/// ・Rigidbody2D による物理移動
/// </summary>
[RequireComponent(typeof(Rigidbody2D))]
public class PlayerTopDown2DController : MonoBehaviour
{
    // ------------------------------
    // 移動設定
    // ------------------------------

    [Header("Movement Settings")]
    [Tooltip("移動スピード")]
    public float moveSpeed = 5f;

    // ------------------------------
    // 内部変数
    // ------------------------------

    private Rigidbody2D rb;
    private Vector2 moveInput;
    private Vector2 moveDirection;

    // Input System
    [SerializeField] private InputActionReference move;

    // ------------------------------
    // 初期化
    // ------------------------------

    private void Awake()
    {
        TryGetComponent(out rb);

        // トップダウンでは重力不要
        rb.gravityScale = 0f;
    }

    private void OnEnable()
    {
        move.action.Enable();
    }

    private void OnDisable()
    {
        move.action.Disable();
    }

    // ------------------------------
    // 更新
    // ------------------------------

    private void Update()
    {
        UpdateMoveInput();        // ① 入力取得
        UpdateMoveDirection();    // ② 移動方向計算
        UpdateFacingDirection(); // ③ 向き更新（見た目）
    }

    private void FixedUpdate()
    {
        ApplyMovement();          // ④ 物理移動
    }

    // ------------------------------
    // 入力取得
    // ------------------------------

    /// <summary>
    /// WASD / 左スティック から移動入力を取得
    /// </summary>
    private void UpdateMoveInput()
    {
        moveInput = move.action.ReadValue<Vector2>();
    }

    // ------------------------------
    // 移動方向計算
    // ------------------------------

    /// <summary>
    /// 入力を正規化して移動方向を決定
    /// </summary>
    private void UpdateMoveDirection()
    {
        moveDirection = moveInput.normalized;
    }

    // ------------------------------
    // 移動反映
    // ------------------------------

    /// <summary>
    /// Rigidbody2D を使って物理移動を行う
    /// </summary>
    private void ApplyMovement()
    {
        rb.velocity = moveDirection * moveSpeed;
    }

    // ------------------------------
    // 向き制御
    // ------------------------------

    /// <summary>
    /// 進行方向に応じてスプライトの向きを更新
    /// </summary>
    private void UpdateFacingDirection()
    {
        if (moveDirection.sqrMagnitude < 0.001f) return;

        // 左右反転
        if (Mathf.Abs(moveDirection.x) > Mathf.Abs(moveDirection.y))
        {
            Vector3 scale = transform.localScale;
            scale.x = Mathf.Sign(moveDirection.x) * Mathf.Abs(scale.x);
            transform.localScale = scale;
        }
    }
}

　以上になります。

このページを編集するこのページを元に新規ページを作成

印刷する

コメント（0）

【初心者向け】Input System の実装例 - i-school 先頭へ

コメントをかく

名前	ユーザIDを使用しないで書き込む	ユーザーIDを使う	ログインする
画像コード	画像に記載されている文字を下のフォームに入力してください。
備考	「http://」を含む投稿は禁止されています。
本文
利用規約をご確認のうえご記入下さい

i-school