Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

LoadSceneMode

Used when loading a Scene in a player.
Read time 1 minuteLast updated 13 days ago

Definition

public enum LoadSceneMode

Remarks

Use LoadSceneMode to choose what type of Scene loads when using SceneManager.LoadScene. The available modes are Single and Additive.
Single mode loads a standard Unity Scene which then appears on its own in the Hierarchy window. Additive loads a Scene which appears in the Hierarchy window while another is active.

Examples

using UnityEngine;using UnityEngine.SceneManagement;public class Example : MonoBehaviour{    void OnGUI()    {        //This displays a Button on the screen at position (20,30), width 150 and height 50. The button’s text reads the last parameter. Press this for the SceneManager to load the Scene.        if (GUI.Button(new Rect(20, 30, 150, 30), "Other Scene Single"))        {            //The SceneManager loads your new Scene as a single Scene (not overlapping). This is Single mode.            SceneManager.LoadScene("YourScene", LoadSceneMode.Single);        }        //Whereas pressing this Button loads the Additive Scene.        if (GUI.Button(new Rect(20, 60, 150, 30), "Other Scene Additive"))        {            //SceneManager loads your new Scene as an extra Scene (overlapping the other). This is Additive mode.            SceneManager.LoadScene("YourScene", LoadSceneMode.Additive);        }    }}

Fields

Value

Description

AdditiveAdds the Scene to the current loaded Scenes.
SingleCloses all current loaded Scenes and loads a Scene.