RuntimeInitializeOnLoadMethodAttribute
Use this attribute to get a callback when the runtime is starting up and loading the first scene.
Read time 4 minutesLast updated 5 days ago
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
- Inherits from: PreserveAttribute
[AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]public class RuntimeInitializeOnLoadMethodAttribute : PreserveAttribute
Remarks
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:
- Various low level systems are initialized (window, assemblies, gfx etc.)
- RuntimeInitializeLoadType.SubsystemRegistration and RuntimeInitializeLoadType.AfterAssembliesLoaded callbacks are invoked.
- More setup (input systems etc.)
- RuntimeInitializeLoadType.BeforeSplashScreen callback is invoked.
- First scene starts loading.
- RuntimeInitializeLoadType.BeforeSceneLoad callback is invoked. Objects of the scene are loaded but hasn't been called yet. All objects are considered inactive.
Awake - and
Awakeare invoked on MonoBehaviours.OnEnable - RuntimeInitializeLoadType.AfterSceneLoad callback is invoked. 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 attribute, but which may not contain types used directly or indirectly in any scenes built for the project.
[RuntimeInitializeOnLoadMethod]Additional Resources: Managed code stripping
Examples
// Demonstration of the RuntimeInitializeOnLoadMethod attributeusing 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."); }}
Constructors
Constructor | Description |
|---|---|
| RuntimeInitializeOnLoadMethodAttribute() | Use the RuntimeInitializeLoadType to control when the callback is invoked. |
| RuntimeInitializeOnLoadMethodAttribute(UnityEngine.RuntimeInitializeLoadType) | Use the RuntimeInitializeLoadType to control when the callback is invoked. |
Properties
Property | Description |
|---|---|
| loadType | Controling the callback invocation time. |