Derive from this base class to provide alternative implementations to the C# behavior of specific SceneManager methods.
The example provided logs if scene loading is done by index and logs a warning to switch to loading by scene path.
using UnityEngine; using Debug = UnityEngine.Debug; using UnityEngine.SceneManagement;
public class SceneIndexLogger : SceneManagerAPI { [RuntimeInitializeOnLoadMethod] static void OnRuntimeMethodLoad() { SceneManagerAPI.overrideAPI = new SceneIndexLogger(); }
protected override int GetNumScenesInBuildSettings() { Debug.LogWarning("SceneManager.GetNumScenesInBuildSettings() called, please load scenes by path to avoid issues when scenes are reordered."); return base.GetNumScenesInBuildSettings(); }
protected override Scene GetSceneByBuildIndex(int buildIndex) { Debug.Log($"SceneManager.GetSceneByBuildIndex(buildIndex = {buildIndex}) called, please load scenes by path to avoid issues when scenes are reordered."); return base.GetSceneByBuildIndex(buildIndex); } }
overrideAPI | The specific SceneManagerAPI instance to use to handle overridden SceneManager methods. |
GetNumScenesInBuildSettings | Override for customizing the behavior of the SceneManager.sceneCountInBuildSettings function. |
GetSceneByBuildIndex | Override for customizing the behavior of the SceneManager.GetSceneByBuildIndex function. |
LoadFirstScene | Override for customizing the behavior of loading the first Scene in a stub player build. |
LoadSceneAsyncByNameOrIndex | Override for customizing the behavior of the SceneManager.LoadScene and SceneManager.LoadSceneAsync functions. |
UnloadSceneAsyncByNameOrIndex | Override for customizing the behavior of the SceneManager.UnloadSceneAsync function. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.