BuildProfile

Provides a set of configuration settings you can use to build your application on a particular platform.

Read time 5 minutes

Last updated 2 days ago

Definition


[HelpURL("build-profiles-reference")][ExcludeFromObjectFactory]public sealed class BuildProfile : ScriptableObject

Property	Description
overrideGlobalScenes	Overrides the global scene list.
scenes	The list of scenes specified in the build profile.
scriptingDefines	Lists the user-specified script compilation defines in the build profile.

Method	Description
AddComponent	Adds a ScriptableObject to the build profile as a sub-asset. Only one instance per type can be embedded within a build profile.
CreateComponent	Creates a new instance of a given scriptable object and adds it as a sub-asset to the build profile. Only one instance per type can be embedded within a build profile.
GetComponent	Returns a component of type `T` . For PlayerSettings, returns the global fallback if no PlayerSettings component is found. Returns null if the component isn't available.
GetScenesForBuild	Obtains the list of scenes used when building with the build profile.
RemoveComponent	Removes a component of type `T` from a given build profile.

Method	Description
CreateBuildProfile	Creates a new build profile asset for the specified platform with the provided name and places it under `Assets/Settings/Build Profiles` .
GetActiveBuildProfile	Gets the active build profile.
GetActiveComponent	Returns a component of type `T` from the active build profile. For PlayerSettings, returns the global fallback if no PlayerSettings component is found. Returns null if the component isn't available.
GetAllBuildProfiles	Retrieves all build profiles available in the project.
GetBuildProfileAtPath	Retrieves the build profile asset located at the specified path within the Unity project.
GetInstalledPlatformModules	Gets a list of all installed platforms.
SetActiveBuildProfile	Sets the active build profile.

Member	Description
activeProfileChanged	Callback invoked when the active build profile has changed to a new value.

Operator	Description
operator ==	Compares two object references to see if they refer to the same object.
bool	Determines whether the object exists.
operator !=	Compares if two objects refer to a different object.