Interface IBuildParameters
Base interface for the parameters container
Namespace: UnityEditor.Build.Pipeline.Interfaces
Syntax
public interface IBuildParameters : IContextObject
Properties
CacheServerHost
Enables and specifies the cache server to use.
Declaration
string CacheServerHost { get; set; }
Property Value
Type | Description |
---|---|
String |
CacheServerPort
The port for the cache server to use
Declaration
int CacheServerPort { get; set; }
Property Value
Type | Description |
---|---|
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 |
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 |
ScriptOutputFolder
Location to be used for compiled scripts generated during the build.
Declaration
string ScriptOutputFolder { get; set; }
Property Value
Type | Description |
---|---|
String |
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 |
---|---|
String |
UseCache
Enables the use of the build cache if set to true.
Declaration
bool UseCache { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
WriteLinkXML
Writes out a link.xml file to the output folder to use with Unity managed code stripping.
Declaration
bool WriteLinkXML { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Methods
GetCompressionForIdentifier(String)
Constructs and returns the BuildCompression struct to use for the specified identifier.
Declaration
Content.BuildCompression GetCompressionForIdentifier(string identifier)
Parameters
Type | Name | Description |
---|---|---|
String | identifier | Identifier used to construct the BuildCompression struct. |
Returns
Type | Description |
---|---|
Content.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. |
GetOutputFilePathForIdentifier(String)
Returns the output folder to use for the specified identifier.
Declaration
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
ScriptCompilationSettings GetScriptCompilationSettings()
Returns
Type | Description |
---|---|
ScriptCompilationSettings | Returns the ScriptCompilationSettings struct to use for script compiling. |