Class SceneList
Contains information about the scenes for the build.
Namespace: Unity.Build.Common
Syntax
public sealed class SceneList : IBuildComponent
Properties
BuildCurrentScene
Declaration
public bool BuildCurrentScene { get; set; }
Property Value
| Type | Description |
|---|---|
| Boolean |
SceneInfos
The list of scene infos for the build.
Declaration
public List<SceneList.SceneInfo> SceneInfos { get; set; }
Property Value
| Type | Description |
|---|---|
| List<SceneList.SceneInfo> |
Scenes
Declaration
[Obsolete("Scenes has been replaced by SceneInfos. (RemovedAfter 2020-05-01)")]
public List<GlobalObjectId> Scenes { get; set; }
Property Value
| Type | Description |
|---|---|
| List<GlobalObjectId> |
Methods
GetSceneInfosForBuild()
Gets the current scene infos for the build. If BuildCurrentScene is checked, all open scenes are returned.
Declaration
public SceneList.SceneInfo[] GetSceneInfosForBuild()
Returns
| Type | Description |
|---|---|
| SceneList.SceneInfo[] | The array of SceneInfos. |
GetScenePathsForBuild()
Gets the scene paths that will be included in the build.
Declaration
public string[] GetScenePathsForBuild()
Returns
| Type | Description |
|---|---|
| String[] | The array of scene paths. |
GetScenePathsToLoad()
Returns all scenes marked as auto load. The first scene is always included.
Declaration
public string[] GetScenePathsToLoad()
Returns
| Type | Description |
|---|---|
| String[] | The array of scene paths to atuomatically load. |