docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class BuildConfiguration

    Can stores a set of hierarchical build components per type, which can be inherited or overridden using dependencies.

    Inheritance
    object
    Object
    ScriptableObject
    ScriptableObjectPropertyContainer<BuildConfiguration>
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>
    BuildConfiguration
    Implements
    ISerializationCallbackReceiver
    Inherited Members
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.AsReadOnly()
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.CreateInstance(BuildConfiguration)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.HasComponent(Type)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.HasComponent<T>()
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.IsComponentInherited(Type)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.IsComponentInherited<T>()
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.IsComponentOverriding(Type)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.IsComponentOverriding<T>()
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.GetComponent(Type)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.GetComponent<T>()
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.TryGetComponent(Type, out IBuildComponent)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.TryGetComponent<T>(out T)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.GetComponentOrDefault(Type)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.GetComponentOrDefault<T>()
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.GetComponents()
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.GetComponents(Type)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.GetComponents<T>()
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.GetComponentTypes()
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.GetComponentSource(Type, bool)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.GetComponentSource<T>(bool)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.SetComponent(IBuildComponent)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.SetComponent<T>(T)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.SetComponent(Type)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.SetComponent<T>()
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.RemoveComponent(Type)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.RemoveComponent<T>()
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.ClearComponents()
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.HasDependency(BuildConfiguration)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.AddDependency(BuildConfiguration)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.GetDependencies()
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.RemoveDependency(BuildConfiguration)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.ClearDependencies()
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.IsComponentOverridden(Type)
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.IsComponentOverridden<T>()
    HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>.SetComponent(Type, IBuildComponent)
    ScriptableObjectPropertyContainer<BuildConfiguration>.CreateInstance(Action<BuildConfiguration>)
    ScriptableObjectPropertyContainer<BuildConfiguration>.CreateAsset(string, Action<BuildConfiguration>)
    ScriptableObjectPropertyContainer<BuildConfiguration>.CreateAssetInActiveDirectory(string, Action<BuildConfiguration>)
    ScriptableObjectPropertyContainer<BuildConfiguration>.LoadAsset(string)
    ScriptableObjectPropertyContainer<BuildConfiguration>.LoadAsset(GUID)
    ScriptableObjectPropertyContainer<BuildConfiguration>.SaveAsset(string)
    ScriptableObjectPropertyContainer<BuildConfiguration>.RestoreAsset()
    ScriptableObjectPropertyContainer<BuildConfiguration>.IsModified()
    ScriptableObjectPropertyContainer<BuildConfiguration>.SerializeToJson()
    ScriptableObjectPropertyContainer<BuildConfiguration>.DeserializeFromJson(BuildConfiguration, string)
    ScriptableObjectPropertyContainer<BuildConfiguration>.SerializeToPath(string)
    ScriptableObjectPropertyContainer<BuildConfiguration>.DeserializeFromPath(BuildConfiguration, string)
    ScriptableObjectPropertyContainer<BuildConfiguration>.OnBeforeSerialize()
    ScriptableObjectPropertyContainer<BuildConfiguration>.OnAfterDeserialize()
    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.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    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 BuildConfiguration : HierarchicalComponentContainer<BuildConfiguration, IBuildComponent>, ISerializationCallbackReceiver

    Fields

    Name Description
    AssetExtension

    File extension for build configuration assets.

    Properties

    Name Description
    Show

    Determine if this build configuration should be shown or hidden.

    Methods

    Name Description
    Build()

    Run the build pipeline of this build configuration to build the target.

    CanBuild()

    Determine if the build pipeline of this build configuration can build.

    CanPrepare()

    Determine if the environment can be prepared before the build pipeline of this build configuration can be used.

    CanRun(params RunTargetBase[])

    Determine if the build pipeline of this build configuration can run.

    Clean()

    Clean the build result from building the build pipeline of this build configuration.

    CleanAllBuildArtifacts()

    Clean all build artifact of every build configuration.

    CleanBuildArtifact()

    Clean the build artifact of the last Build() performed.

    CleanBuildArtifact(BuildPipelineBase)

    Clean the build artifact of the last Build() performed.

    GetActive()

    Retrieve the current active build configuration. Value is stored per-project and per-user.

    GetAllBuildArtifacts()

    Get all build artifact values.

    GetAllBuildArtifacts(BuildPipelineBase)

    Get all build artifact values.

    GetBuildArtifact(Type)

    Get the first build artifact value that is assignable to specified type.

    GetBuildArtifact(BuildPipelineBase, Type)

    Get the first build artifact value that is assignable to specified type.

    GetBuildArtifact<T>()

    Get the first build artifact value that is assignable to specified type.

    GetBuildArtifact<T>(BuildPipelineBase)

    Get the first build artifact value that is assignable to specified type.

    GetBuildPipeline()

    Retrieve the build pipeline of this build configuration.

    GetBuildResult()

    Get the build result of the last Build() performed.

    GetBuildResult(BuildPipelineBase)

    Get the build result of the last Build() performed.

    GetLastBuildArtifact(Type)
    GetLastBuildArtifact<T>()
    GetLastBuildResult()
    GetOutputBuildDirectory()

    Get the output build directory override for this build configuration. The output build directory can be overridden using a OutputBuildDirectory component.

    GetPlatform()

    Retrieve the platform of this build configuration.

    HasBuildArtifact(Type)

    Determine if a build artifact that is assignable to the specified type is present.

    HasBuildArtifact(BuildPipelineBase, Type)

    Determine if a build artifact that is assignable to the specified type is present.

    HasBuildArtifact<T>()

    Determine if a build artifact that is assignable to the specified type is present.

    HasBuildArtifact<T>(BuildPipelineBase)

    Determine if a build artifact that is assignable to the specified type is present.

    IsComponentUsed(Type)

    Determine if component is used by the build pipeline of this build configuration. Returns false if this build configuration does not have a build pipeline.

    IsComponentUsed<T>()

    Determine if component is used by the build pipeline of this build configuration. Returns false if this build configuration does not have a build pipeline.

    Prepare()

    Prepare the environment to use the build pipeline of this build configuration.

    Run(params RunTargetBase[])

    Run the resulting target from building the build pipeline of this build configuration.

    SetActive(BuildConfiguration)

    Set current active build configuration. The build configuration must have a build pipeline set, and be buildable.

    Events

    Name Description
    ActiveChanged

    Event fired when active build configuration is changed.

    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)