We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

Search Results for

    Show / Hide Table of Contents

    Class BuildInfo

    Inheritance
    Object
    BuildInfo
    UwpBuildInfo
    Implements
    IBuildInfo
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Microsoft.MixedReality.Toolkit.Build.Editor
    Assembly: cs.temp.dll.dll
    Syntax
    public class BuildInfo : IBuildInfo

    Constructors

    BuildInfo(Boolean)

    Declaration
    public BuildInfo(bool isCommandLine = false)
    Parameters
    Type Name Description
    Boolean isCommandLine

    Properties

    AutoIncrement

    Should the build auto increment the build version number?

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

    BuildOptions

    Build options to include in the Unity player build pipeline.

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

    BuildPlatform

    The build platform (i.e. x86, x64)

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

    BuildSymbols

    The symbols associated with this build.

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

    BuildTarget

    The build target.

    Declaration
    public virtual BuildTarget BuildTarget { get; }
    Property Value
    Type Description
    BuildTarget

    ColorSpace

    Optional parameter to set the player's ColorSpace

    Declaration
    public ColorSpace? ColorSpace { get; set; }
    Property Value
    Type Description
    Nullable<ColorSpace>

    Configuration

    The build configuration (i.e. debug, release, or master)

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

    IsCommandLine

    Is this build being issued from the command line?

    Declaration
    public bool IsCommandLine { get; }
    Property Value
    Type Description
    Boolean

    LogDirectory

    The default location of log files generated by sub-processes of the build system.

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

    Note that this different from the Unity flag -logFile, which controls the location of the Unity log file. This is specifically for logs generated by other processes that the MRTK build tools produces (for example, when msbuild.exe is involved)

    OutputDirectory

    The directory to put the final build output.

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

    Defaults to "Application.dataPath/Builds/Platform Target/"

    PostBuildAction

    A post-build action to raise after building the Unity player.

    Declaration
    public Action<IBuildInfo, BuildReport> PostBuildAction { get; set; }
    Property Value
    Type Description
    Action<IBuildInfo, BuildReport>

    PreBuildAction

    A pre-build action to raise before building the Unity player.

    Declaration
    public Action<IBuildInfo> PreBuildAction { get; set; }
    Property Value
    Type Description
    Action<IBuildInfo>

    Scenes

    The list of scenes to include in the build.

    Declaration
    public IEnumerable<string> Scenes { get; set; }
    Property Value
    Type Description
    IEnumerable<String>

    ScriptingBackend

    Optional parameter to set the scripting backend

    Declaration
    public ScriptingImplementation? ScriptingBackend { get; set; }
    Property Value
    Type Description
    Nullable<ScriptingImplementation>

    Implements

    IBuildInfo
    In This Article
    Back to top Generated by DocFX