Interface IBuildParameters

Base interface for the parameters container

Namespace: UnityEditor.Build.Pipeline.Interfaces

Syntax

public interface IBuildParameters : IContextObject

Properties

CacheServerHost

Declaration

string CacheServerHost { get; set; }

Property Value

Type	Description
System.String

CacheServerPort

The port for the cache server to use

Declaration

int CacheServerPort { get; set; }

Property Value

Type	Description
System.Int32

ContentBuildFlags

The set of build flags to use for building content.

Declaration

ContentBuildFlags ContentBuildFlags { get; set; }

Property Value

Type	Description
ContentBuildFlags

Group

Target build platform group.

Declaration

BuildTargetGroup Group { get; set; }

Property Value

Type	Description
BuildTargetGroup

OutputFolder

Final output location where built content will be written.

Declaration

string OutputFolder { get; set; }

Property Value

Type	Description
System.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

TypeDB ScriptInfo { get; set; }

Property Value

Type	Description
TypeDB

ScriptOptions

Script compilation options to use for the script compiling step.

Declaration

ScriptCompilationOptions ScriptOptions { get; set; }

Property Value

Type	Description
ScriptCompilationOptions

Target

Target build platform.

Declaration

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

string TempOutputFolder { get; set; }

Property Value

Type	Description
System.String

UseCache

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

Declaration

bool UseCache { get; set; }

Property Value

Type	Description
System.Boolean

Methods

GetCompressionForIdentifier(String)

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

Declaration

BuildCompression GetCompressionForIdentifier(string identifier)

Parameters

Type	Name	Description
System.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

BuildSettings GetContentBuildSettings()

Returns

Type	Description
BuildSettings	Returns the BuildSettings struct to use for content building.

GetScriptCompilationSettings()

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

Declaration

ScriptCompilationSettings GetScriptCompilationSettings()

Returns

Type	Description
ScriptCompilationSettings	Returns the ScriptCompilationSettings struct to use for script compiling.