Class BuildSettings
Can stores a set of unique components, which can be inherited or overridden using dependencies.
Inheritance
BuildSettings
Inherited Members
Namespace: Unity.Build
Syntax
public sealed class BuildSettings : ComponentContainer<BuildSettings, IBuildSettingsComponent>, ISerializationCallbackReceiverFields
AssetExtension
File extension for BuildSettings assets.
Declaration
public const string AssetExtension = ".buildsettings"Field Value
| Type | Description |
|---|---|
| String |
Methods
Build()
Run the BuildPipeline of this BuildSettings to build the target.
Declaration
public BuildPipelineResult Build()Returns
| Type | Description |
|---|---|
| BuildPipelineResult | The result of the BuildPipeline build. |
CanBuild(out String)
Determine if the BuildPipeline of this BuildSettings can build.
Declaration
public bool CanBuild(out string reason)Parameters
| Type | Name | Description |
|---|---|---|
| String | reason | If CanBuild(out String) returns false, the reason why it fails. |
Returns
| Type | Description |
|---|---|
| Boolean | Whether or not the BuildPipeline can build. |
CanRun(out String)
Determine if the BuildPipeline of this BuildSettings can run.
Declaration
public bool CanRun(out string reason)Parameters
| Type | Name | Description |
|---|---|---|
| String | reason | If CanRun(out String) returns false, the reason why it fails. |
Returns
| Type | Description |
|---|---|
| Boolean | Whether or not the BuildPipeline can run. |
GetBuildPipeline()
Retrieve the BuildPipeline of this BuildSettings.
Declaration
public BuildPipeline GetBuildPipeline()Returns
| Type | Description |
|---|---|
| BuildPipeline | The BuildPipeline if found, otherwise null. |
Run()
Run the resulting target from building the BuildPipeline of this BuildSettings.
Declaration
public RunStepResult Run()Returns
| Type | Description |
|---|---|
| RunStepResult |