docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class Batch

    Supports command line invocation through the Unity Editor.

    Inheritance
    object
    Batch
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEditor.PackageManager.DocumentationTools.UI
    Assembly: Unity.PackageManagerDocTools.Editor.dll
    Syntax
    public class Batch
    Remarks

    Note that importing or removing a package also triggers a domain reload, which causes any state or event listeners to be lost. If something works for the first package in the list, but not others, a domain reload might be the culprit.

    Methods

    Name Description
    AddPackages()

    Performs the add operation.

    AddPackagesFromString(string)

    Adds packages from a list to the project.

    GenerateDocs()
    GenerateDocsFromString(string)

    Generates the docs for the packages in the list, which must already be installed in the project.

    GenerateDocsWithStatus()

    Performs the generate operation and reports the status of the build in a file at the location specified in the batchmode args, this method is intended to be used by an automated pipeline.

    RemovePackages()

    Performs the remove operation.

    RemovePackagesFromString(string)

    Removes a list of packages from the project.

    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)