ドキュメント

Unity Engine

Unity Engine

スクリプトの検査

Inspector ウィンドウで C# スクリプトのフィールドを表示および編集します。
読み終わるまでの所要時間 13 分最終更新 5日前

Project ウィンドウでスクリプトアセットを選択すると、Inspector は、そのアセットが属するアセンブリの名前やコンテンツのプレビューなど、基本情報の一部を表示します。
注
Inspector にスクリプトのコンテンツが表示されますが、Inspector ウィンドウでコンテンツを編集することはできません。

The script Inspector displaying an example script.

スクリプト Inspector には、Open (開く) と Execution Order (実行順) の 2 つのボタンも表示されます。
Open は、Project ウィンドウでスクリプトをダブルクリックして、現在設定されている外部スクリプト エディタでスクリプトを開くのと同じ機能を実行します。Unity がスクリプトを開くために使う外部エディタは、Preferences ウィンドウの外部ツールセクションで設定できます。
Execution Order (実行順) ボタンを押すと、 Project Settings ウィンドウの Script Execution Order (スクリプト実行順) セクション が開き、Unity がスクリプトを実行する順序を設定できます。

Inspector ウィンドウのスクリプトコンポーネント

MonoBehaviour スクリプトはすべてコンポーネントとして使用できます。つまり、
以下のコード例では、
myName
という public フィールドを宣言しています。このスクリプトをシーンのゲームオブジェクトに追加すると、フィールドは
Inspector

?

ウィンドウに My Name というラベルのフィールドとして表示されます。スクリプトで宣言された
none
のデフォルト値が Inspector ウィンドウのデフォルト値になり、フィールドに入力して変更できます。
using UnityEngine;using System.Collections;public class MainPlayer :MonoBehaviour { public string myName = "none"; // Use this for initialization void Start () { Debug.Log("I am alive and my name is " + myName); }}
スクリプトコンポーネントをアタッチ、設定、添付する各ゲームオブジェクトは、フィールドに一意の値を持つことができます。

A public string field editable in the Inspector window.

フィールド名は、「 フィールド名からラベルへの変換 」で説明されているルールに従って Inspector ウィンドウのラベルに変換されます。ただし、これらの変更は単にディスプレイ目的です。コードでは常にフィールド名を使用する必要があります。
Inspector ウィンドウで、My Name の値を編集して再生を押すと、コンソールメッセージに入力したテキストが含まれるようになります。

A debug message appears in the Unity console, which reads "I am alive and my name is Earl".

Public フィールドと Private フィールド

すべての
public
フィールドは、デフォルトで Inspector ウィンドウで編集可能です。パブリック変数が Inspector ウィンドウに表示されないようにするには、 HideInInspector 属性を追加します。Inspector ウィンドウで
private
フィールドを編集可能にするには、SerializeField 属性を追加します。
注
再生モードでの実行中に、エディターのスクリプトのフィールドの値を変更できます。これにより、停止および再起動することなく、変更の影響を直接確認できます。ただし、再生モードを終了すると、フィールドの値は再生モードに入る前の値にリセットされます。

オブジェクトリファレンスフィールド

bool
、
string
、
int
などの単純ビルトイン C# 型だけでなく、
UnityEngine.Object
から継承した型のフィールドを Inspector ウィンドウで編集可能にすることもできます。これには、すべてのビルトインコンポーネントタイプ (Transform、AudioSource、Camera、ライトなど)、独自の MonoBehaviour スクリプトタイプ、多くのアセットタイプが含まれます。
これにより、独自のスクリプトコンポーネントで Unity エディターのドラッグアンドドロップシステムを使用できます。例えば、スクリプトに public
Transform
フィールドを作成し、それをあるゲームオブジェクトに追加すると、別のゲームオブジェクトを Inspector ウィンドウのそのフィールドにドラッグして、そのゲームオブジェクトの Transform コンポーネントへのリファレンスを設定できます。このリファレンスには、スクリプトでランタイムにアクセスできます。
例えば、この
Follow
スクリプトは、あるゲームオブジェクトを別のゲームオブジェクトに追従させます。
using UnityEngine;public class Follow :MonoBehaviour{ public Transform objectToFollow; public float followSpeed = 1; void Update() { // calculate the distance between this object and the target object // and move a small portion of that distance each frame: var delta = objectToFollow.position - transform.position; transform.position += delta * Time.deltaTime * followSpeed; }}
スクリプトには
Transform
型の public フィールドがあります。これは、割り当て可能なフィールドとしてエディターに表示されます。Hierarchy ウィンドウから別のゲームオブジェクトをこのフィールドにドラッグアンドドロップすると、そのゲームオブジェクトにアタッチされた Transform コンポーネントへのリファレンスがエディターによって割り当てられます。
次のスクリーンショットでは、スクリプトはスフィアゲームオブジェクトに配置され、キューブは階層からオブジェクト To Follow フィールドにドラッグアンドドロップされています。

A public Transform field with a GameObject assigned. Here the script is on the Sphere (currently selected), and the Cube was dragged and dropped from the Hierarchy into the Sphere's Object To Follow field

デフォルト オブジェクト参照

MonoBehaviour スクリプトでエディターに割り当て可能な public オブジェクトフィールドを定義する場合は、これらのフィールドのデフォルト参照を設定できます。デフォルトのリファレンスフィールドは、Project ウィンドウでスクリプトアセットを選択すると Inspector に表示されます。

A MonoBehaviour script with three AudioClip fields. The default references for these fields are shown unset.

上の例では、デフォルトの参照が割り当てられていない 3 つのパブリックオーディオクリップフィールドがあります。AudioClip の各デフォルトリファレンスフィールドにオーディオクリップを割り当てることができます。
デフォルト参照を割り当てると、MonoBehaviour をゲームオブジェクトにコンポーネントとして追加したとき、またはゲームオブジェクト上の MonoBehaviour の既存のインスタンスをデフォルト値にリセットしたときに適用されます。
注
GameObjects の MonoBehaviour インスタンスの参照とデフォルト参照の間に継続的なリンクはありません。つまり、デフォルトの参照を変更しても、既存のGameObjectsオブジェクトでは自動的に更新されません。
UnityEngine.Object
を継承しないその他のタイプの Inspector 編集可能フィールド (例えば、public 文字列や int フィールド) には、Inspector のデフォルトフィールドはありません。代わりに、スクリプト自体からデフォルト値が使用されます。

null リファレンス例外

Unity は、Inspector ウィンドウで初期化する必要のある変数を初期化し忘れた場合に
NullReferenceException
をスローします。以下の例に示すように、
try
/
catch
ブロックでこれを処理できます。
using UnityEngine;using System;using System.Collections;public class Example2 :MonoBehaviour { public Light myLight; // set in the inspector void Start () { try { myLight.color = Color.yellow; } catch (NullReferenceException ex) { Debug.Log("myLight was not set in the inspector"); } } }
このコード例では、
myLight
という変数は Inspector ウィンドウで設定する必要がある
Light
です。この変数が設定されていない場合は、デフォルトで
null
になります。
try
ブロックのライトの色を変更しようとすると、
NullReferenceException
が発生します。この場合、
catch
ブロックコードは Inspector でライトを設定するように促すメッセージを表示します。

フィールド名からラベルへの変換

Unity は、一連のルールに従って、Inspector ウィンドウで C# フィールド名をラベルに変換します。例えば、上記の例の変数名は、
myName
から My Name に、
objectToFollow
から Object To Follow に変換されています。ルールは以下の通りです。
  • 最初の文字を大文字にする
  • 小文字と大文字の間にスペースを加える
  • 頭文字と次の単語の先頭の大文字の間にスペースを追加する
  • Remove any
    m_
    プレフィックス
  • 任意の
    k
    プレフィックスの削除
  • 任意の
    _
    プレフィックスの削除
iPad
や
x64
など、これらのルールが適用されない特殊なケースもあります。

追加リソース