Version: Unity 6.6 Alpha (6000.6)
LanguageEnglish
  • C#

BuildProfileSettingsProvider

class in UnityEditor.Build.Profile

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

Cancel

Description

Provides the display information for a custom settings foldout in the Build Profile window.

Use this class with BuildProfileSettingsProviderAttribute to register a custom settings foldout in the Build Profile window. Additional resources: BuildProfileSettingsProviderAttribute.

using UnityEngine;
using UnityEditor.Build.Profile;

class SampleSettings : ScriptableObject { public bool myBoolSetting; [BuildProfileSettingsProvider(typeof(SampleSettings))] static BuildProfileSettingsProvider createProvider() => new BuildProfileSettingsProvider("MySampleSettings") { tooltip = "Sample settings provider for a ScriptableObject.", canAddSetting = profile => true }; }

Properties

Property Description
canAddSettingCallback that determines if the settings object this provider describes can be added to the given build profile. Must be set for settings to appear in the Build Profile window; when not set, the settings will not be shown.
displayNameDisplay name for the settings foldout in the Build Profile window.
hasCustomEditorWhen the value is true, Unity uses a custom implementation of an Editor. Otherwise, Unity displays the default inspector for the settings object.
tooltipTooltip text for the settings foldout. If this value is empty, no tooltip is displayed.

Constructors

Constructor Description
BuildProfileSettingsProviderInitializes a new instance of BuildProfileSettingsProvider with the specified display name.