Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

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

SceneManager.GetSceneByBuildIndex

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 static function GetSceneByBuildIndex(buildIndex: int): SceneManagement.Scene;
public static SceneManagement.Scene GetSceneByBuildIndex(int buildIndex);

Parameters

buildIndex Build index as shown in the Build Settings window.

Returns

Scene A reference to the scene, if valid. If not, an invalid scene is returned.

Description

Get a scene struct from a build index.

This method will return a valid Scene if a scene has been added to the build settings at the given build index AND the scene is loaded. If it has not been loaded yet the SceneManager cannot return a valid Scene.
See Also: SceneManager.GetSceneAt, SceneUtility.GetBuildIndexBySceneName.