【Unity】CharacterController IsGrounded の判定を改善する

**UniRxについての記事のまとめは[こちら](http://qiita.com/toRisouP/items/48b9fa25df64d3c6a392)**

---
Unity開発において、プレイヤキャラクタを作る際によく使われるコンポーネントに[CharacterController](http://docs-jp.unity3d.com/Documentation/Components/class-CharacterController.html)があります。
このコンポーネントは、オブジェクトが移動する時の床や壁の当たり判定、坂道の傾斜や段差の乗り越えなどの判定を勝手に計算してくれるとても便利なコンポーネントです。

ただしこのCharacterController、**接地判定のIsGroundedの精度がイマイチ**だったりします。
坂道や段差を移動中、明らかに接地しているにも関わらずfalse判定が返ってきたりします。
そのためIsGroundedを基準にジャンプの可否を決定している場合、なかなかジャンプしてくれず非常にレスポンスの悪い挙動になってしまったりします。
![CharacterController.png](https://qiita-image-store.s3.amazonaws.com/0/47146/79f95c8e-6c32-094a-6291-ae88d6872fce.png)
（斜面を移動中はIsGroundedがtrue/falseで激しく値が変動してしまう）


そこで今回は、このIsGroundedの判定を上手いこと誤魔化して改善してみようと思います。

# 方法1: Raycastを利用する

IsGroundedは、厳密にピッタリと床に接してないとtrueになってくれません。
そこでこの判定を甘くし、ある程度床に近ければ「地面に接している」と判定するようにしてみます。

判定には[Physics.Raycast](http://docs.unity3d.com/ScriptReference/Physics.Raycast.html)という、オブジェクトとの衝突を調べる機能を利用します。
（名前の通り、ある点から仮想的な光線を出し、それが物体にぶつかるかを調べる機能です）

このRaycastをGameObjectの足元から発射し、Raycastが地面と衝突するかどうかで地面に接しているか判定してみます。

![Raycast.png](https://qiita-image-store.s3.amazonaws.com/0/47146/741adead-b972-22a4-dafa-3df95713bfbc.png)
（オブジェクトの底から真下にRaycastを放ち、衝突するかどうかで接地しているか調べる）

```csharp:RaycastCheck
using UnityEngine;

public class RaycastCheck : MonoBehaviour
{
    // Rayの長さ
    [SerializeField] private float _rayLength = 1f;

    // Rayをどれくらい身体にめり込ませるか
    [SerializeField] private float _rayOffset;

    // Rayの判定に用いるLayer
    [SerializeField] private LayerMask _layerMask = default;

    private CharacterController _characterController;
    private bool _isGround;

    private void Start()
    {
        // CharacterControllerを取得
        _characterController = GetComponent<CharacterController>();
    }

    private void FixedUpdate()
    {
        // 接地判定
        _isGround = CheckGrounded();
    }

    private bool CheckGrounded()
    {
        // 放つ光線の初期位置と姿勢
        // 若干身体にめり込ませた位置から発射しないと正しく判定できない時がある
        var ray = new Ray(origin: transform.position + Vector3.up * _rayOffset, direction: Vector3.down);

        // Raycastがhitするかどうかで判定
        // レイヤの指定を忘れずに
        return Physics.Raycast(ray, _rayLength, _layerMask);
    }

    // Debug用にRayを可視化する
    private void OnDrawGizmos()
    {
        // 接地判定時は緑、空中にいるときは赤にする
        Gizmos.color = _isGround ? Color.green : Color.red;
        Gizmos.DrawRay(transform.position + Vector3.up * _rayOffset, Vector3.down * _rayLength);
    }
}

```

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/47146/45cb604a-9cd2-373d-8e36-0d608b067e7a.png)
（RayがヒットするLayerを指定すること）

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/47146/6c647787-f642-cfd3-3dca-f506e254af6b.png)
（Rayを可視化した様子）

このようにRaycastを使うことで地面との接地判定を甘くすることができます。
ただしこの方法には次のような欠点もあるので、そこは工夫が必要です。

* Rayの長さを長くしすぎると、ジャンプしているのに接地したままの判定になることがある
    * ジャンプ直後はRayを一時的に短くするなどの工夫が必要
* 地面が凸凹している場合は正しく判定できないことがある
    * [SphereCastやBoxCast](https://tsubakit1.hateblo.jp/entry/2016/02/25/025922)などを代わりに使うなどするとよい

# 方法2:IsGroundedの値の変動が落ち着くまでIsGroundedの値を無視する

IsGroundedの値をよく観察していると、「ジャンプや着地の直後」「斜面を移動中」はtrue/falseを変動し値がブレまくってることがわかります。
そこで、この値がぶれている間は値を無視し、値が落ち着いた時に利用するようにしてみます。
（最後に値が変化してからnミリ秒経過した時にその値で確定させる）

こういった時間が絡んだ判定処理にはRxが向いているので、RxのUnity向け実装の[UniRx](https://github.com/neuecc/UniRx)を使い書いてみます。

```csharp:CheckGroundedComponent.cs
using UnityEngine;
using UniRx;
using System;

public class CheckGroundedComponent : MonoBehaviour
{
    private bool _isGrounded;

    /// <summary>
    /// 地面に接地しているかどうか
    /// </summary>
    public bool IsGrounded { get { return _isGrounded; } }

    void Start()
    {
        var controller = GetComponent<CharacterController>();
        controller
            .ObserveEveryValueChanged(x => x.isGrounded)
            .ThrottleFrame(5)
            .Subscribe(x => _isGrounded = x);
    }
}

```

CharacterController.IsGroundedをラップし、値が最後に変化してから5フレーム安定するまではその値を無視するようにしてみました。



# 方法１と方法２どっちが良いか

細かく挙動を調整できるという点で「方法１」の方が良いです。
方法２は覚えておく程度で、実際に使う機会はそんなにないと思います。