Class BuildParameters | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class BuildParameters

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

    Inheritance
    System.Object
    BuildParameters
    BundleBuildParameters
    Namespace: UnityEditor.Build.Pipeline
    Syntax
    public class BuildParameters : IBuildParameters

    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.

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

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

    CacheServerPort

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

    ContentBuildFlags

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

    Group

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

    OutputFolder

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

    ScriptInfo

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

    ScriptOptions

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

    Target

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

    TempOutputFolder

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

    UseCache

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

    Methods

    GetCompressionForIdentifier(String)

    Declaration
    public BuildCompression GetCompressionForIdentifier(string identifier)
    Parameters
    Type Name Description
    System.String identifier
    Returns
    Type Description
    BuildCompression

    GetContentBuildSettings()

    Declaration
    public BuildSettings GetContentBuildSettings()
    Returns
    Type Description
    BuildSettings

    GetScriptCompilationSettings()

    Declaration
    public ScriptCompilationSettings GetScriptCompilationSettings()
    Returns
    Type Description
    ScriptCompilationSettings
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023