docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class BuildPipeline

    Defines a list of IBuildStep to run in order.

    Inheritance
    object
    Object
    ScriptableObject
    ScriptableObjectPropertyContainer<BuildPipeline>
    BuildPipeline
    Implements
    ISerializationCallbackReceiver
    IBuildStep
    Inherited Members
    ScriptableObjectPropertyContainer<BuildPipeline>.JsonVisitorRegistration
    ScriptableObjectPropertyContainer<BuildPipeline>.AssetChanged
    ScriptableObjectPropertyContainer<BuildPipeline>.CreateInstance(Action<BuildPipeline>)
    ScriptableObjectPropertyContainer<BuildPipeline>.CreateAsset(string, Action<BuildPipeline>)
    ScriptableObjectPropertyContainer<BuildPipeline>.LoadAsset(string)
    ScriptableObjectPropertyContainer<BuildPipeline>.LoadAsset(GUID)
    ScriptableObjectPropertyContainer<BuildPipeline>.SaveAsset(string)
    ScriptableObjectPropertyContainer<BuildPipeline>.RestoreAsset()
    ScriptableObjectPropertyContainer<BuildPipeline>.SerializeToJson()
    ScriptableObjectPropertyContainer<BuildPipeline>.DeserializeFromJson(BuildPipeline, string)
    ScriptableObjectPropertyContainer<BuildPipeline>.SerializeToPath(string)
    ScriptableObjectPropertyContainer<BuildPipeline>.DeserializeFromPath(BuildPipeline, string)
    ScriptableObjectPropertyContainer<BuildPipeline>.SerializeToStream(Stream)
    ScriptableObjectPropertyContainer<BuildPipeline>.DeserializeFromStream(BuildPipeline, Stream)
    ScriptableObjectPropertyContainer<BuildPipeline>.OnBeforeSerialize()
    ScriptableObjectPropertyContainer<BuildPipeline>.OnAfterDeserialize()
    ScriptableObjectPropertyContainer<BuildPipeline>.OnEnable()
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(string)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectOfType<T>()
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetType()
    Namespace: Unity.Build
    Assembly: solution.dll
    Syntax
    public sealed class BuildPipeline : ScriptableObjectPropertyContainer<BuildPipeline>, ISerializationCallbackReceiver, IBuildStep

    Fields

    Name Description
    AssetExtension

    File extension for BuildPipeline assets.

    BuildSteps
    RunStep

    Properties

    Name Description
    Description

    Description of this BuildPipeline displayed in build progress reporting.

    OptionalComponents

    List of IBuildSettingsComponent derived types that are optional for this BuildPipeline.

    RequiredComponents

    List of IBuildSettingsComponent derived types that are required for this BuildPipeline.

    Methods

    Name Description
    Build(BuildSettings, BuildProgress, Action<BuildContext>)

    Build this BuildPipeline.

    CanBuild(BuildSettings, out string)

    Determine if this BuildPipeline can build.

    CanRun(BuildSettings, out string)

    Determine if this BuildPipeline can run.

    CleanupBuildStep(BuildContext)

    Cleanup the IBuildStep list of this BuildPipeline. Cleanup will only be called for IBuildStep that ran.

    IsEnabled(BuildContext)

    Determine if this BuildPipeline will be executed or not.

    Reset()

    Reset this asset in preparation for deserialization.

    Run(BuildSettings)

    Run this BuildPipeline. This will attempt to run the build target produced from building this BuildPipeline.

    RunBuildStep(BuildContext)

    Run the IBuildStep list of this BuildPipeline. If a IBuildStep fails, subsequent IBuildStep are not run.

    Sanitize()

    Sanitize this asset after deserialization.

    In This Article
    Back to top
    Copyright © 2024 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)