RuntimeInitializeOnLoadMethodAttribute

Description

Use this attribute to get a callback when the runtime is starting up and loading the first scene.

Use the various options for RuntimeInitializeLoadType to control when the method is invoked in the startup sequence.

The following list shows the execution order of the RuntimeInitializeLoadType callbacks:

1. First various low level systems are initialized (window, assemblies, gfx etc.)
2. Then SubsystemRegistration and AfterAssembliesLoaded callbacks are invoked.
3. More setup (input systems etc.)
4. Then BeforeSplashScreen callback is invoked.
5. Now the first scene starts loading.
6. Then BeforeSceneLoad callback is invoked. Here objects of the scene is loaded but Awake() has not been called yet. All objects are considered inactive here.
7. Now Awake() and OnEnable() are invoked on MonoBehaviours.
8. Then AfterSceneLoad callback is invoked. Here objects of the scene are considered fully loaded and setup. Active objects can be found with FindObjectsByType.

The above details are when starting up a Player build. When entering Play mode in the Editor the same invocations are ensured.

The default callback invocation time is RuntimeInitializeLoadType.AfterSceneLoad. The execution order within each of the RuntimeInitializeLoadType callbacks is not guaranteed.

Note: Use the AlwaysLinkAssemblyAttribute on package or precompiled assemblies that contain one or more methods with the [RuntimeInitializeOnLoadMethod] attribute, but which may not contain types used directly or indirectly in any scenes built for the project.

Additional resources: Managed code stripping

// Demonstration of the RuntimeInitializeOnLoadMethod attribute
using UnityEngine;

class MyClass
{
    [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSplashScreen)]
    static void OnBeforeSplashScreen()
    {
        Debug.Log("Before SplashScreen is shown and before the first scene is loaded.");
    }

    [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)]
    static void OnBeforeSceneLoad()
    {
        Debug.Log("First scene loading: Before Awake is called.");
    }

    [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.AfterSceneLoad)]
    static void OnAfterSceneLoad()
    {
        Debug.Log("First scene loaded: After Awake is called.");
    }

    [RuntimeInitializeOnLoadMethod]
    static void OnRuntimeInitialized()
    {
        Debug.Log("Runtime initialized: First scene loaded: After Awake is called.");
    }
}

Properties

Constructors

Inherited Members