Version: 5.4 beta (switch to 5.3)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Scene

struct in UnityEngine.SceneManagement

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

Sumbission failed

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

Close

Cancel

Description

Run-time data structure for *.unity file.

Variables

buildIndexReturns the index of the scene in the Build Settings. Always returns -1 if the scene was loaded through an AssetBundle.
isDirtyReturns true if the scene is modifed.
isLoadedReturns true if the scene is loaded.
nameReturns the name of the scene.
pathReturns the relative path of the scene. Like: "Assets/MyScenes/MyScene.unity".
rootCountThe number of root transforms of this scene.

Public Functions

GetRootGameObjectsReturns all the root game objects in the scene.
IsValidWhether this is a valid scene. A scene may be invalid if, for example, you tried to open a scene that does not exist. In this case, the scene returned from EditorSceneManager.OpenScene would return False for IsValid.

Operators

operator !=Returns true if the Scenes are different.
operator ==Returns true if the Scenes are equal.