Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

Scene.name

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public string name;

Description

Returns the name of the Scene that is currently active in the game or app.

The Scene.name returns a run-time, read-only, string value. The name limits to 244 characters. The Scene name defaults to scene. The user changes the name during game creation.

The following script example changes the Scene depending on GUI.Button clicks and the name of the Scene. To make this example work:

  1. Create a Project with two Scenes, scene1 and scene2.
  2. Attach the script below to a GameObject added to scene1.
  3. Attach the same script to a GameObject added to scene2.
  4. Click on the GameObject and go to the Inspector.
  5. In the My First Scene field and My Second Scene fields, enter the names of the Scenes you would like to switch between, scene1 and scene2.
  6. Select scene1 by double-clicking it in the Project, and press Play. The scene1 scene will appear.
  7. Click the Load Next Scene button and scene2 will be loaded.
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.SceneManagement;

public class Example : MonoBehaviour { // These are the Scene names. Make sure to set them in the Inspector window. public string myFirstScene, mySecondScene;

private string nextButton = "Load Next Scene"; private string nextScene; private static bool created = false;

private Rect buttonRect; private int width, height;

void Awake() { Debug.Log("Awake:" + SceneManager.GetActiveScene().name);

// Ensure the script is not deleted while loading. if (!created) { DontDestroyOnLoad(this.gameObject); created = true; } else { Destroy(this.gameObject); }

// Specify the items for each scene. Camera.main.clearFlags = CameraClearFlags.SolidColor; width = Screen.width; height = Screen.height; buttonRect = new Rect(width / 8, height / 3, 3 * width / 4, height / 3); }

void OnGUI() { // Return the current Active Scene in order to get the current Scene name. Scene scene = SceneManager.GetActiveScene();

// Check if the name of the current Active Scene is your first Scene. if (scene.name == myFirstScene) { nextButton = "Load Next Scene"; nextScene = mySecondScene; } else { nextButton = "Load Previous Scene"; nextScene = myFirstScene; }

// Display the button used to swap scenes. GUIStyle buttonStyle = new GUIStyle(GUI.skin.GetStyle("button")); buttonStyle.alignment = TextAnchor.MiddleCenter; buttonStyle.fontSize = 12 * (width / 200);

if (GUI.Button(buttonRect, nextButton, buttonStyle)) { SceneManager.LoadScene(nextScene); } } }

The following example using two scenes, and one of them has a long Scene name with 244 digits. The other is called testScene. To make this example work:
1. Create a new Project.
2. Change the name of the default scene to testScene by selecting it and then use Assets->Rename.
3. Next, create a second scene and again select it and use Asset->Rename. Use the name as shown below. (This is the 244 character name "0123456789...0123").
4. Create a C# Script and call it Example.cs.
5. Add the following script text to Example.cs.
6. Next add an empty GameObject called GameObject to each of the two scenes.
7. Finally copy Example.cs to each of the two GameObjects.
Use the Game button to launch the testScene scene. A GUI Button is shown which allows the scenes to swap.

using UnityEngine;
using UnityEngine.SceneManagement;

// SceneManagement.SceneManager-name example

public class Example : MonoBehaviour { private Scene scene;

void Start() { scene = SceneManager.GetActiveScene(); Debug.Log("Name: " + scene.name); }

void OnGUI() { if (GUI.Button(new Rect(10, 10, 150, 100), "Change Scene")) { if (scene.name == "testScene") { // The scene to load has a 244 characters name. SceneManager.LoadScene("0123456789012345678901234567890123456789" + "012345678901234567890123456789012345678901234567890123456789" + "012345678901234567890123456789012345678901234567890123456789" + "012345678901234567890123456789012345678901234567890123456789" + "012345678901234567890123"); } else { SceneManager.LoadScene("testScene"); } } } }