【Unity】Unityのデバッグ手法入門 - Debug.Logとエラー対処法

概要

プログラミングにバグはつきものです。どれだけ注意深くコードを書いても、予期せぬエラーや意図しない挙動は必ず発生します。優れた開発者とは、バグを書かない人ではなく、バグを効率的に見つけ出し、修正できる人のことです。このバグを見つけ出す作業をデバッグと呼びます。

Unityには、このデバッグ作業を助けるための強力なツールがいくつも用意されています。この記事では、最も手軽で基本的なデバッグ手法であるDebug.Logの使い方から、Unityがコンソールに表示するエラーメッセージの読み解き方、そしてより高度なデバッグを可能にするデバッガの基本的な使い方まで、初心者が知っておくべきデバッグの基礎を解説します。

最も簡単なデバッグツール: `Debug.Log()`

Debug.Log()は、指定したメッセージをUnityエディタのコンソールウィンドウに出力するメソッドです。これは、プログラムの特定の部分が実行されているかを確認したり、その時点での変数の値を確認したりするための、最もシンプルで効果的な方法です。

using UnityEngine;

public class DebugExample : MonoBehaviour
{
    private int score = 0;

    void Start()
    {
        // ゲーム開始時にメッセージを出力
        Debug.Log("ゲームが開始されました。");
    }

    void Update()
    {
        // ボタンが押されたかを確認
        if (Input.GetKeyDown(KeyCode.Space))
        {
            score += 10;
            // 現在のスコア変数の値を出力
            Debug.Log("スペースキーが押されました。現在のスコア: " + score);
        }
    }
}

コンソールウィンドウは、Unityエディタ上部のWindow > General > Consoleから開くことができます。

`Debug.LogWarning()` と `Debug.LogError()`

Debugクラスには、メッセージの重要度に応じて使い分けるためのバリエーションがあります。

Debug.LogWarning(): 警告メッセージ（黄色のアイコン）を出力します。エラーではないが、注意すべき状況（例: 設定されていないオプションがあるなど）で使います。
Debug.LogError(): エラーメッセージ（赤色のアイコン）を出力します。プログラムの実行に支障をきたす致命的な問題が発生したときに使います。

これらを使い分けることで、コンソールログが整理され、問題の重要度を素早く把握できます。

エラーメッセージの読み解き方

プログラムに問題があると、Unityはコンソールに赤色のエラーメッセージを表示します。初心者のうちはこのエラーメッセージに圧倒されてしまうかもしれませんが、落ち着いて読めば、問題解決のための重要なヒントが書かれています。

よくあるエラー: `NullReferenceException`

これは「ぬるぽ」としても知られる、最も頻繁に遭遇するエラーの一つです。「実体のない（nullの）オブジェクトのメソッドやプロパティにアクセスしようとした」ときに発生します。

原因の例:

GetComponent<T>()でコンポーネントを取得しようとしたが、実際にはアタッチされていなかった。
Inspectorウィンドウで設定すべきpublic変数が設定されていない（空のまま）。

// 例: Rigidbodyがアタッチされていないのにアクセスしようとした
public class NullRefExample : MonoBehaviour
{
    private Rigidbody rb;

    void Start()
    {
        // ここでrbに何も代入されない
    }

    void FixedUpdate()
    {
        // rbはnullなので、ここでNullReferenceExceptionが発生する
        rb.AddForce(Vector3.up);
    }
}

対処法: エラーメッセージをダブルクリックすると、エラーが発生したコードの行にジャンプできます。その行で使われている変数がnullになっていないか、Debug.Logで確認したり、if (variable != null)でチェックしたりして原因を特定します。

デバッガを使ったステップ実行

Debug.Logは手軽ですが、プログラムの実行を止めて、その瞬間のすべての変数の状態をじっくりと観察したい場合もあります。そのような高度なデバッグを可能にするのがデバッガです。

Visual StudioやRiderといったコードエディタには、Unityと連携するデバッガが内蔵されています。

基本的な使い方:

ブレークポイントの設定: コードエディタで、調査したいコードの行の左側をクリックして、赤い丸（ブレークポイント）を設定します。
Unityにアタッチ: コードエディタの「Unityにアタッチ」ボタン（通常は再生ボタンのようなアイコン）を押して、デバッガをUnityエディタに接続します。
ゲームの実行: Unityエディタでゲームを再生します。
実行の中断: プログラムの実行がブレークポイントを設定した行に到達すると、そこで一時停止します。
変数の確認とステップ実行: 実行が停止した状態で、コードエディタのデバッグウィンドウに変数の値一覧が表示されます。ここから、「1行進む（ステップオーバー）」「関数の中に入る（ステップイン）」などの操作を行い、プログラムの動きを1行ずつ詳細に追跡できます。

デバッガの使いこなしは少し慣れが必要ですが、複雑なバグを解決するための最強の武器となります。

まとめ

デバッグは、試行錯誤のプロセスです。エラーを恐れず、むしろ問題解決への手がかりとして活用する姿勢が重要です。

Debug.Logを積極的に使う: 変数の値やプログラムの通過点を気軽に確認しよう。
エラーメッセージをよく読む: 問題の種類と発生場所が書かれている宝の地図です。
NullReferenceExceptionを警戒する: オブジェクトやコンポーネントが正しく設定・取得されているか常に意識しよう。
デバッガに挑戦する: 複雑な問題に直面したら、デバッガを使ってプログラムの内部を覗いてみよう。

これらのデバッグスキルを身につけることで、開発のスピードと品質は飛躍的に向上します。

Menu

【Unity】Unityのデバッグ手法入門 - Debug.Logとエラー対処法

概要

最も簡単なデバッグツール: Debug.Log()

Debug.LogWarning() と Debug.LogError()

エラーメッセージの読み解き方

よくあるエラー: NullReferenceException

デバッガを使ったステップ実行

まとめ

最も簡単なデバッグツール: `Debug.Log()`

`Debug.LogWarning()` と `Debug.LogError()`

よくあるエラー: `NullReferenceException`