エディター起動時のプロジェクトコードの実行
Run Edit mode code automatically when the Editor launches using the InitializeOnLoad attribute.
読み終わるまでの所要時間 4 分最終更新 1ヶ月前
Edit モードのプロジェクトコードの一部を、Unity エディターの起動時にユーザーアクションなしで即座に実行すると便利な場合があります。これは InitializeOnLoad 属性を静的コンストラクターのあるクラスに適用することで実現できます。静的コンストラクターは、クラスと同じ名前の関数で、 宣言され、戻り値の型やパラメーターを持ちません。詳細については、Microsoft C# ドキュメントの Static constructors を参照してください。
staticusing UnityEngine;using UnityEditor;[InitializeOnLoad]public class Startup { static Startup() { Debug.Log("Up and running"); }}
静的コンストラクターは、どのような静的関数やクラスのインスタンスが使用されるよりも先に呼び出されることが保証されていますが、 属性によりエディター起動時に呼び出されることが保証されます。この属性を持つ静的コンストラクターは、プロジェクト内のスクリプトが再コンパイルされるときに呼び出されます。これは ドメインリロード とも呼ばれます。これは以下のときに発生します。
InitializeOnLoad- Unity が最初にプロジェクトをロードしたとき。
- Preferences ウィンドウ の Asset Pipeline セクションで Auto Refresh が有効になっている場合に、Unity がスクリプトの変更を検出したとき。
- Play Mode 設定 で Domain Reload が有効になっている場合に、再生モードを開始したとき。
ロード時初期化機能の使用例は、定期的なコールバックの設定です。これは、エディターアプリケーションの "フレーム更新" のようなものと考えることができます。EditorApplication クラスには update というデリゲートがあり、これはエディターが実行されている間、1 秒間に何度も呼び出されます。以下のコード例では、 で装飾された小さなカスタムクラスを定義し、メンバーメソッドを デリゲートに割り当てます。これにより、メソッドが実行され、エディター起動時にコンソールに が出力されます。
[InitializeOnLoad]EditorApplication.updateUpdatingusing UnityEditor;using UnityEngine;// InitializeOnLoad ensures this code runs on Editor launch[InitializeOnLoad]class MyClass{ // Define a static constructor in which we assign the custom Update method to the delegate static MyClass () { EditorApplication.update += Update; } // Define a method with the required signature that performs work we want to do on launch static void Update () { Debug.Log("Updating"); }}