Class BuildParameters

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

Inheritance

object

BuildParameters

BundleBuildParameters

Implements

IBuildParameters

IContextObject

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEditor.Build.Pipeline

Assembly: Unity.ScriptableBuildPipeline.Editor.dll

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 BuildCompression BundleCompression { get; set; }

Property Value

Type	Description
BuildCompression

CacheServerHost

Enables and specifies the cache server to use.

Declaration

public string CacheServerHost { get; set; }

Property Value

Type	Description
string

CacheServerPort

The port for the cache server to use

Declaration

public int CacheServerPort { get; set; }

Property Value

Type	Description
int

ContentBuildFlags

The set of build flags to use for building content.

Declaration

public ContentBuildFlags ContentBuildFlags { get; set; }

Property Value

Type	Description
ContentBuildFlags

Group

Target build platform group. BuildTargetGroup

Declaration

public BuildTargetGroup Group { get; set; }

Property Value

Type	Description
BuildTargetGroup

NonRecursiveDependencies

Calculates and build asset bundles using Non-Recursive Dependency calculation methods. This approach helps reduce asset bundle rebuilds and runtime memory consumption.

Declaration

public bool NonRecursiveDependencies { get; set; }

Property Value

Type	Description
bool

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

ScriptOptions

Script compilation options to use for the script compiling step.

Declaration

public ScriptCompilationOptions ScriptOptions { get; set; }

Property Value

Type	Description
ScriptCompilationOptions

ScriptOutputFolder

Location to be used for compiled scripts generated during the build.

Declaration

public string ScriptOutputFolder { get; set; }

Property Value

Type	Description
string

Target

Target build platform. BuildTarget

Declaration

public BuildTarget Target { get; set; }

Property Value

Type	Description
BuildTarget

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

UseCache

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

Declaration

public bool UseCache { get; set; }

Property Value

Type	Description
bool

WriteLinkXML

Writes out a link.xml file to the output folder to use with Unity managed code stripping.

Declaration

public bool WriteLinkXML { get; set; }

Property Value

Type	Description
bool

Methods

GetCompressionForIdentifier(string)

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

Declaration

public virtual BuildCompression GetCompressionForIdentifier(string identifier)

Parameters

Type	Name	Description
string	identifier	Identifier used to construct the BuildCompression struct.

Returns

Type	Description
BuildCompression	Returns the BuildCompression struct to use for a specific identifier.

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.

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.

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

IBuildParameters

IContextObject