Unity_Lesson

Interactionを使用し、少し複雑な入力を実装する

1.Interaction概要

InteractionはInput Action内で使用され、Actionまたはその中のBindingに対して1つまたは複数指定することが可能です。　
基本的な入力パターンは幾つかプリセットとして用意されていますが、これらで物足りない場合は自作することも可能です。

2.Interactionとは

特定の入力パターンを表現するものです。
例えば、HoldというInteractionは「一定時間ボタンが押され続けた」という入力パターンを表します。

3.Interactionの基本的な仕組み

内部的には、次のステートマシンとして管理されます。

Interactionでは、この状態はフェーズと呼ばれています。次の5つのフェーズがあります。

Waiting – 入力待ち状態
Started – Interactionが開始された状態
Performed – Interactionが期待する入力を満たした状態
Canceled – Interactionがキャンセルされた状態
Disabled – Actionが無効な状態

このうち、Interactionが直接扱うのはDisabled以外の4フェーズです。また、Performedフェーズに限り、同じPerformedフェーズに遷移することも出来ます。

4.各フェーズ遷移時に発生するイベント

Interaction内でステートマシンとして管理される各フェーズ間で遷移する時、次のイベントが発生します。

started – 入力され始めた時などに呼ばれる
performed – 特定の入力があった時などに呼ばれる
canceled – 入力が中断された時などに呼ばれる

基本的に、Started、Performed、Canceledフェーズに遷移する時に上記イベントがコールバックとして通知されます。
PerformedフェーズからPerformedフェーズへの遷移でもperformedコールバックは通知されます。
また、Waiting、Disabledフェーズへの遷移ではイベントは発火しません。

5.Interactionの適用

Interactionは、各BindingまたはAction単位で1つ以上指定できます。

Actionに直接Interactionを指定した場合は、その下のBindingすべてにInteractionが指定されたのと同じことになります。

Interactionが未指定の場合は、Default Interactionが暗黙的に指定されます。

6.入力の受取りテスト

指定したActionのコールバックをログ出力する例になります

InteractionExample.cs

    using UnityEngine;
    using UnityEngine.InputSystem;

    public class InteractionExample : MonoBehaviour
    {
        // 入力を受け取る対象のAction
        [SerializeField] private InputActionReference _actionRef;

        private void Awake()
        {
            // InputActionReferenceのActionに対して、
            // 3つのイベントハンドラを登録する
            _actionRef.action.started   += OnAction;
            _actionRef.action.performed += OnAction;
            _actionRef.action.canceled  += OnAction;
        }

        private void OnDestroy()
        {
            // 登録したイベントハンドラを解除する
            _actionRef.action.started 　-= OnAction;
            _actionRef.action.performed -= OnAction;
            _actionRef.action.canceled  -= OnAction;
        }

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

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

        private void OnAction(InputAction.CallbackContext context)
        {
            // Interactionのフェーズをログに出力する
            print($"OnAction: {context.phase}");
        }
    }

上記をInteractionExample.csという名前でUnityプロジェクトに保存し、適当なゲームオブジェクトにアタッチし、インスペクターよりInteractionが適用されたActionを指定してください。

Hold Interactionが指定された場合、対象ボタンを一定時間押し込むとPerformedフェーズに遷移してログ出力されます。

一定時間に満たないうちにボタンを離すと、Performedフェーズに遷移しません。

7.ReadValueで入力値を取得する場合

InputAction action;// 独自のInteractionが設定されたAction

・・・（中略）・・・

private void Update()
{
    // フェーズがWaitingのままだと常に0を返す
    var value = action.ReadValue<float>();
}

Updateイベント等でReadValueメソッドを通じて入力値を取得する場合、Waitingフェーズでは入力値が常に0。

プリセットとして提供されているInteractionは、いずれも入力があった時にStartedフェーズに遷移するため、ReadValueメソッドから入力値を取得できます。
ただし、自作のInteractionを用いる場合、入力があってもStartedフェーズに遷移しない実装になっているとReadValueが返す値はいつまでも0のままなので注意

8.Default Interactionの挙動

Interactionが指定されていないBindingには、暗黙的にDefault Interactionが指定されます。

Default Interactionの挙動は、Action PropertiesのAction項目から設定

基本的な挙動はAction Typeの設定によって決まります。

Value
入力値が変化したときにフェーズ遷移。
0から0以外に変化したときはStarted → Performedの順に遷移。
0以外から別の0以外の値に変化したときはPerformedからPerformedに遷移。
0以外から0に変化したときはCanceledに遷移。
Button
入力値が0から0以外に変化したときにはStartedに遷移。
Press Point以上に変化したときにPerformedに遷移。
PerformedフェーズでRelease Point未満に値が変化するとCanceledに遷移。
Pass Through
デバイスからの入力がある度に常にPerformedに遷移。