BuildDestinationSettings

Description

A build profile component that specifies the destination path Unity uses when it builds the profile.

Add this component to a build profile to set a build location for the profile. When the profile is active, Unity uses the resolved value of BuildDestinationSettings.buildPath as the output path for the build. If you start a build with BuildPipeline.BuildPlayer(BuildPlayerWithProfileOptions) or from the command line and provide a build path, Unity uses that path instead of the buildPath value in this component.

using UnityEditor;
using UnityEditor.Build.Profile;
using UnityEngine;

public static class BuildDestinationExample
{
    [MenuItem("Build/Build iOS Demo")]
    public static void MyBuild()
    {
        BuildProfile profile = AssetDatabase.LoadAssetAtPath<BuildProfile>(
            "Assets/Settings/Build Profiles/iOSDemo.asset");
        if (profile == null)
            return;

        // Get or create the BuildDestinationSettings component on the profile.
        var destination = profile.GetComponent<BuildDestinationSettings>();
        if (destination == null)
            destination = profile.CreateComponent<BuildDestinationSettings>();

        // Set a build path with a variable that resolves to the product name.
        destination.buildPath = "Builds/[UnityEditor.PlayerSettings.productName]";

        // Reading buildPath returns the resolved path.
        // For example, "Builds/MyGame" when productName is "MyGame".
        Debug.Log($"Build destination: {destination.buildPath}");

        // Unity automatically uses the resolved buildPath from
        // the BuildDestinationSettings component when building.
        BuildPipeline.BuildPlayer(new BuildPlayerWithProfileOptions
        {
            buildProfile = profile
        });
    }
}

Properties

Inherited Members