InitializeOnLoadAttribute
Allows you to initialize an Editor class when Unity loads, and when your scripts are recompiled.
Read time 4 minutesLast updated 4 days ago
Definition
- Type: Class
- Namespace: UnityEditor
- Assembly: UnityEditor
- Inherits from: Attribute
- Implements: _Attribute
[AttributeUsage(AttributeTargets.Class)]public class InitializeOnLoadAttribute : Attribute, _Attribute
Remarks
Static constructors with this attribute are called when scripts in the project are recompiled, also known as a Domain Reload). This happens when:
- Unity first loads your project.
- Unity detects modifications to scripts, if Auto Refresh is enabled in the Asset Pipeline section of the Preferences window).
- Entering Play mode, if domain reload is enabled in your Play Mode configuration).
Avoid asset operations such as asset loading in methods. methods are called before asset import completes, which means asset loading from this context can fail, resulting in a null object. To do initialization after a domain reload that requires asset operations, use the AssetPostprocessor.OnPostprocessAllAssets(string[], string[], string[], string[], bool) callback. This callback supports all asset operations and has a parameter that signals if there was a domain reload.
InitializeOnLoadInitializeOnLoadAdditional Resources: InitializeOnLoadMethodAttribute.
Examples
// The following code example defines a small custom class decorated with `[InitializeOnLoad]`// and assigns a member method to the `EditorApplication.update` delegate so that it runs and begins// printing to the console on Editor launch.using 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"); }}