docs.unity3d.com
    Show / Hide Table of Contents

    Class BuildProfile

    Class BuildProfile.

    Inheritance
    Object
    Object
    ScriptableObject
    BuildProfile
    Inherited Members
    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, Boolean)
    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, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, Boolean)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindObjectOfType(Type, Boolean)
    Object.ToString()
    Object.name
    Object.hideFlags
    Namespace: Unity.Industrial.Forma.Core.Publishing
    Syntax
    [Serializable]
    [CreateAssetMenu(fileName = "BuildProfile.asset", menuName = "Forma/Build/Create Profile", order = 0)]
    [MovedFrom(true, "UnityEditor.Industrial.Configuring.Build", "Unity.Industrial.Configurator", null)]
    public class BuildProfile : ScriptableObject, ISerializationCallbackReceiver

    Fields

    AddressableLocalBuildPath

    The addressable local build path

    Declaration
    [SerializeField]
    public string AddressableLocalBuildPath
    Field Value
    Type Description
    String

    AddressableLocalLoadPath

    The addressable local load path

    Declaration
    [SerializeField]
    public string AddressableLocalLoadPath
    Field Value
    Type Description
    String

    BuildType

    What should be produced by build

    Declaration
    [SerializeReference]
    [Tooltip("What should be produced by build?")]
    public IBuildType BuildType
    Field Value
    Type Description
    IBuildType

    CompatibilitySettings

    Compatibility settings

    Declaration
    public List<ScriptableObject> CompatibilitySettings
    Field Value
    Type Description
    List<ScriptableObject>

    DefaultAddressableRemoteBuildPath

    The addressable remote build path

    Declaration
    [Header("Build paths")]
    [SerializeField]
    public string DefaultAddressableRemoteBuildPath
    Field Value
    Type Description
    String

    detailedBuildReport

    Generates more information in the BuildReport

    Declaration
    public bool detailedBuildReport
    Field Value
    Type Description
    Boolean

    DevelopmentMode

    The development mode

    Declaration
    [SerializeField]
    public bool DevelopmentMode
    Field Value
    Type Description
    Boolean

    EnableMeshMerge

    Determines if product model meshes should be merged

    Declaration
    [Header("Product Settings")]
    public bool EnableMeshMerge
    Field Value
    Type Description
    Boolean

    LastBuildPath

    The last build path

    Declaration
    [SerializeField]
    public string LastBuildPath
    Field Value
    Type Description
    String

    ProductCatalogs

    The product catalogs

    Declaration
    [SerializeField]
    public List<ExportableProductCatalog> ProductCatalogs
    Field Value
    Type Description
    List<ExportableProductCatalog>

    ProfileId

    The profile identifier

    Declaration
    [Header("General Settings")]
    public string ProfileId
    Field Value
    Type Description
    String

    SelectedBuildTarget

    String representation of the selected build target for this build profile

    Declaration
    public string SelectedBuildTarget
    Field Value
    Type Description
    String
    Remarks

    Replaces SupportedBuildTarget since we want to allow custom user-defined build target

    ShaderPreprocessorOptions

    Shader preprocessor options used when stripping render pipeline shaders that is not in effect for a build

    Declaration
    [SerializeField]
    public ShaderPreprocessorOptions ShaderPreprocessorOptions
    Field Value
    Type Description
    ShaderPreprocessorOptions

    SupportedBuildTarget

    The selected supported build target

    Declaration
    [Obsolete]
    [HideInInspector]
    public SupportedBuildTarget SupportedBuildTarget
    Field Value
    Type Description
    SupportedBuildTarget
    Remarks

    This will be obsolete. Use SelectedBuildTarget instead.

    uiResourceProvider

    The UI Resource Provider

    Declaration
    [SerializeField]
    public Object uiResourceProvider
    Field Value
    Type Description
    Object

    WaitForManagedDebugger

    The wait for managed debugger

    Declaration
    [SerializeField]
    public bool WaitForManagedDebugger
    Field Value
    Type Description
    Boolean

    Properties

    ConfiguratorProfileReference

    The configurator profile reference

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

    DisplayName

    Gets or sets the display name.

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

    The display name.

    productList

    Get a flattened list of products this build profile references

    Declaration
    public IEnumerable<Product> productList { get; }
    Property Value
    Type Description
    IEnumerable<Product>

    ProductPublishers

    Supported publishers for Forma products. Includes both selected and unselected publishers.

    Declaration
    public IEnumerable<AbstractPublisher> ProductPublishers { get; }
    Property Value
    Type Description
    IEnumerable<AbstractPublisher>

    RuntimePublishers

    Supported publishers for Forma player. Includes both selected and unselected publishers.

    Declaration
    public IEnumerable<AbstractPublisher> RuntimePublishers { get; }
    Property Value
    Type Description
    IEnumerable<AbstractPublisher>

    Methods

    GetSupportedBuildTargetWithCurrentPlatform()

    Gets the supported build target with current platform.

    Declaration
    public static SupportedBuildTarget GetSupportedBuildTargetWithCurrentPlatform()
    Returns
    Type Description
    SupportedBuildTarget

    SupportedBuildTarget.

    OnAfterDeserialize()

    Called when [after deserialize].

    Declaration
    public void OnAfterDeserialize()
    Implements
    ISerializationCallbackReceiver.OnAfterDeserialize()

    OnBeforeSerialize()

    Called when [before serialize].

    Declaration
    public void OnBeforeSerialize()
    Implements
    ISerializationCallbackReceiver.OnBeforeSerialize()

    SetDefaultValues()

    Sets the default values.

    Declaration
    [ContextMenu("Set Default Values", false, 10)]
    public void SetDefaultValues()

    TraverseEditableProducts(Action<Product>)

    Traverses all products in this build profile in an editable state

    Declaration
    public void TraverseEditableProducts(Action<Product> action)
    Parameters
    Type Name Description
    Action<Product> action

    Extension Methods

    ExportProfileExtension.ToFormaSupportedBuildTarget(BuildProfile)
    ExportProfileExtension.ToUnityBuildTarget(BuildProfile)
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023