Version: 2021.3
LanguageEnglish
  • C#

EditorBuildSettings

class in UnityEditor

/

Inherits from:Object

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

Description

This class allows you to modify the Editor Build Settings via script. See EditorBuildSettings.scenes for an example of how to use this class.

Additional resources: EditorBuildSettingsScene, EditorBuildSettings.scenes.

Static Properties

scenesThe list of Scenes that should be included in the build. This is the same list of Scenes that is shown in the Build Settings window. You can modify this list to set up which Scenes should be included in the build.

Static Methods

AddConfigObjectStore a reference to a config object by name. The object must be an asset in the project, otherwise it will not be saved when the editor is restarted or scripts are reloaded. To avoid name conflicts with other packages, it is recommended that names are qualified by a namespace, i.e. "company.package.name".
GetConfigObjectNamesReturn a string array containing the names of all stored config object references.
RemoveConfigObjectRemove a config object reference by name.
TryGetConfigObjectRetrieve a config object reference by name.

Events

sceneListChangedA delegate called whenever EditorBuildSettings.scenes is set.

Inherited Members

Properties

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
FindObjectsOfTypeGets a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.