【Unity】リファレンスの読み方【Debug.Log()から理解】

今回はUnityが提供するソフトウエアのスクリプトリファレンスの読み方（見方）を書きます。

この記事で行う事

Debug.Log()とはいったい何者なのかリファレンスを読んで理解する。

リファレンスを読めば大体何とかなりそうな雰囲気にする。

読むもの
スクリプトリファレンス
1. Classes
まとめ
制作で詰まった時は
もう一つのブックマークしておくべきリファレンス

読むもの

Unityスクリプトリファレンス(2019.3)

スクリプトリファレンス

Unityのソフトウエアが提供するスクリプトリファレンスには利用可能なクラスを中心にメソッドやプロパティ、必要な情報にアクセスできるようになっています。また付属するサンプルコードに関しては、

多くのページにはその機能を利用するためのサンプルコードが用意されており、このサンプルコードは用途を問わずUnityからの許諾や著作権表記の必要なく、自由にご利用頂けます。
unity DOCUMENTATION スクリプティングAPI Unityスクリプトリファレンスへようこそ！

リファレンスの左サイドバーには名前空間一覧が並んでいます。

Classes

名前空間内のクラス・構造体が入っています。

目的の名前空間が分かっている場合、開いて下から見ます。

UnityEngine　＞　Classes　＞　Debug

上のリファレンスページを見ると、こんなことが分かります。

Debug.Log()は

Debug：クラス

class in UnityEngine：UnityEngineという名前空間内にある

Static関数/Log ：Debug.Log(“文字列”)で”文字列”をUnity Consoleに出力していた

ページ内には変数、関数といった項目毎に纏められていますが、

どのようにしてそれらを使うのかを理解することで読んですぐ使えるようになるはずです。

ので、それぞれの項目に対応した簡単な使い方を纏めます。

タイトル

最上部に大文字で書かれているものはタイトルです。

class / struct in 名前空間名

using 名前空間名;

タイトルすぐ下に書かれている一行です。

クラスを使用する際には名前空間を参照する必要があり、usingディレクティブで指定します。

また、この場合は、”クラス名/構造体名＝タイトル”を示しています。

//class in UnityEngineより
using UnityEngine;

Static 変数

（構造体名と同じ型の）変数 = 構造体名.Static変数名;

UnityEngine　＞　Classes　＞　Vector3

//Vector3　は struct in UnityEngineより、
using UnityEngine;
public class Vector3Practice : MonoBehaviour
{
    void Start()
    {
       // Vector3.back は Vector3(0, 0, -1) と同じ意味なので、
       Vector3 myVector = Vector3.back;
    }
}

変数

インスタンス.変数 =（構造体名と同じ型の）変数や定数

Static関数

クラス名.Static関数();

構造体名. Static関数();

using UnityEngine;

public class DebugPractice : MonoBehaviour
{
    void Start()
    {
      //Debug.Log内　public static void Log (object message);より、返り値の無いStatic関数
      //messageは表示の際に文字列として変換対象となる文字列やオブジェクトなので
	    Debug.Log("HW");
    }
}

コンストラクタ

クラス名インスタンス = new コンストラクタ名();

インスタンス生成時実行される初期化メソッド。

コンストラクタ名はクラス名と同じ。

UnityEngine　＞　Classes　＞　Vector3

//Vector3　は struct in UnityEngineより、
using UnityEngine;
public class Vector3Practice
{
    //Vector3のコンストラクタはpublic Vector3 (float x, float y, float z);より、
    //
    Vector3 myVector = new Vector3(1.0f, 0.0f, 0.0f);

}

デストラクタ

インスタンスが消滅する際に実行される処理。アンマネージドリソースで記述