[ Web Proxy ]
URL:
Viewing: https://docs.unity3d.com/ScriptReference/Build.Profile.BuildProfile.html [Back]  [Original]

Unity - Scripting API: BuildProfile
Version: Unity 6.5 (6000.5)
    • Supported
    • Legacy
    LanguageEnglish
    • C#

    BuildProfile

    class in UnityEditor.Build.Profile

    /

    Inherits from:ScriptableObject

    Suggest a change

    Success!

    Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

    Close

    Submission failed

    For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

    Close
    Your name Your email Suggestion* Submit suggestion

    Cancel

    Description

    Provides a set of configuration settings you can use to build your application on a particular platform.

    Additional resources: BuildPlayerWithProfileOptions.

    Properties

    Property Description
    overrideGlobalScenesOverrides the global scene list.
    scenesThe list of scenes specified in the build profile.
    scriptingDefinesLists the user-specified script compilation defines in the build profile.

    Public Methods

    Method Description
    AddComponentAdds a ScriptableObject to the build profile as a sub-asset. Only one instance per type can be embedded within a build profile.
    CreateComponentCreates a new instance of a given scriptable object and adds it as a sub-asset to the build profile. Only one instance per type can be embedded within a build profile.
    GetComponentReturns a component of type T. For PlayerSettings, returns the global fallback if no PlayerSettings component is found. Returns null if the component isn't available.
    GetScenesForBuildObtains the list of scenes used when building with the build profile.
    RemoveComponentRemoves a component of type T from a given build profile.

    Static Methods

    Method Description
    CreateBuildProfileCreates a new build profile asset for the specified platform with the provided name and places it under Assets/Settings/BuildProfiles.
    GetActiveBuildProfileGets the active build profile.
    GetActiveComponentReturns a component of type T from the active build profile. For PlayerSettings, returns the global fallback if no PlayerSettings component is found. Returns null if the component isn't available.
    GetAllBuildProfilesRetrieves all build profiles available in the project.
    GetBuildProfileAtPathRetrieves the build profile asset located at the specified path within the Unity project.
    GetInstalledPlatformModulesGets a list of all installed platforms.
    SetActiveBuildProfileSets the active build profile.

    Events

    Event Description
    activeProfileChangedCallback invoked when the active build profile has changed to a new value.

    Inherited Members

    Properties

    PropertyDescription
    hideFlagsControls whether the object is hidden, saved with the scene, and editable by the user.
    nameThe name of the object.

    Public Methods

    MethodDescription
    GetEntityIdGets the EntityId of the object.
    GetHashCodeReturns the hash code for the object.
    ToStringReturns the name of the object.

    Static Methods

    MethodDescription
    DestroyRemoves a GameObject, component, or asset.
    DestroyImmediateDestroys the specified object immediately. Use with caution and in Edit mode only.
    DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
    FindAnyObjectByTypeRetrieves any active loaded object of Type T.
    FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
    InstantiateClones the object original and returns the clone.
    InstantiateAsyncCaptures a snapshot of the original object that's related to another GameObject and obtains an AsyncInstantiateOperation instance of the resulting objects.
    CreateInstanceCreates an instance of a scriptable object.

    Operators

    OperatorDescription
    boolDetermines whether the object exists.
    operator !=Compares if two objects refer to a different object.
    operator ==Compares two object references to see if they refer to the same object.

    Messages

    MessageDescription
    AwakeCalled when an instance of ScriptableObject is created.
    OnDestroyThis function is called when the scriptable object will be destroyed.
    OnDisableThis function is called when the scriptable object goes out of scope.
    OnEnableThis function is called when the object is loaded.
    OnValidateEditor-only function that Unity calls when the script is loaded or a value changes in the Inspector.
    ResetReset to default values.

    Web Proxy Viewer  |  New URL  |  Original Page