Class BuildParameters

Basic implementation of IBuildParameters. Stores the set of parameters passed into the Scriptable Build Pipeline. IBuildParameters

Inheritance
Object
BuildParameters
BundleBuildParameters
Namespace: UnityEditor.Build.Pipeline
Syntax
[Serializable]
public class BuildParameters : IBuildParameters, IContextObject

Constructors

BuildParameters(BuildTarget, BuildTargetGroup, String)

Default constructor, requires the target, group and output parameters at minimum for a successful build.

Declaration
public BuildParameters(BuildTarget target, BuildTargetGroup group, string outputFolder)
Parameters
Type Name Description
BuildTarget target

The target for building content.
BuildTargetGroup group

The group for building content.
String outputFolder

The final output location for built content.

Properties

BundleCompression

Default compression option to use for all built content files

Declaration
public Content.BuildCompression BundleCompression { get; set; }
Property Value
Type Description
UnityEditor.Build.Content.BuildCompression

CacheServerHost

Declaration
public string CacheServerHost { get; set; }
Property Value
Type Description
String
Implements

CacheServerPort

The port for the cache server to use

Declaration
public int CacheServerPort { get; set; }
Property Value
Type Description
Int32
Implements

ContentBuildFlags

The set of build flags to use for building content.

Declaration
public ContentBuildFlags ContentBuildFlags { get; set; }
Property Value
Type Description
ContentBuildFlags
Implements

Group

Target build platform group.

Declaration
public BuildTargetGroup Group { get; set; }
Property Value
Type Description
BuildTargetGroup
Implements

OutputFolder

Final output location where built content will be written.

Declaration
public string OutputFolder { get; set; }
Property Value
Type Description
String

ScriptInfo

Scripting type information to use when building content. Setting this to a previously cached value will prevent the default script compiling step.

Declaration
public TypeDB ScriptInfo { get; set; }
Property Value
Type Description
TypeDB
Implements

ScriptOptions

Script compilation options to use for the script compiling step.

Declaration
public ScriptCompilationOptions ScriptOptions { get; set; }
Property Value
Type Description
ScriptCompilationOptions
Implements

Target

Target build platform.

Declaration
public BuildTarget Target { get; set; }
Property Value
Type Description
BuildTarget
Implements

TempOutputFolder

Temporary location to be used for artifacts generated during the build but are not part of the final output.

Declaration
public string TempOutputFolder { get; set; }
Property Value
Type Description
String
Implements

UseCache

Enables the use of the build cache if set to true.

Declaration
public bool UseCache { get; set; }
Property Value
Type Description
Boolean
Implements

Methods

GetCompressionForIdentifier(String)

Constructs and returns the BuildCompression struct to use for the specified identifier.

Declaration
public virtual Content.BuildCompression GetCompressionForIdentifier(string identifier)
Parameters
Type Name Description
String identifier

Identifier used to construct the BuildCompression struct.
Returns
Type Description
UnityEditor.Build.Content.BuildCompression

Returns the BuildCompression struct to use for a specific identifier.
Implements

GetContentBuildSettings()

Constructs and returns the BuildSettings struct to use for content building.

Declaration
public virtual BuildSettings GetContentBuildSettings()
Returns
Type Description
BuildSettings

Returns the BuildSettings struct to use for content building.
Implements

GetOutputFilePathForIdentifier(String)

Returns the output folder to use for the specified identifier.

Declaration
public virtual string GetOutputFilePathForIdentifier(string identifier)
Parameters
Type Name Description
String identifier

Identifier used to identify which output folder to use.
Returns
Type Description
String

Returns the output folder to use for the specified identifier.
Implements

GetScriptCompilationSettings()

Constructs and returns the ScriptCompilationSettings struct to use for script compiling.

Declaration
public virtual ScriptCompilationSettings GetScriptCompilationSettings()
Returns
Type Description
ScriptCompilationSettings

Returns the ScriptCompilationSettings struct to use for script compiling.
Implements