Class UserSettingsProvider

A SettingsProvider implementation that creates an interface from settings reflected from a collection of assemblies.

Inheritance
object
SettingsProvider
UserSettingsProvider
Inherited Members
SettingsProvider.PopulateSearchKeywordsFromGUIContentProperties<T>()
SettingsProvider.GetSearchKeywordsFromGUIContentProperties<T>()
Namespace: UnityEditor.SettingsManagement
Assembly: Unity.Settings.Editor.dll
Syntax
public sealed class UserSettingsProvider : SettingsProvider

Constructors

UserSettingsProvider(string, Settings, Assembly[], SettingsScope)

Create a new UserSettingsProvider.

Declaration
public UserSettingsProvider(string path, Settings settings, Assembly[] assemblies, SettingsScope scopes = SettingsScope.User)
Parameters
Type Name Description
string path

The settings menu path.
Settings settings

The Settings instance that this provider is inspecting.
Assembly[] assemblies

A collection of assemblies to scan for UserSettingAttribute and UserSettingBlockAttribute attributes.
SettingsScope scopes

Which scopes this provider is valid for.
Exceptions
Type Condition
ArgumentNullException

Thrown if settings or assemblies is null.

Fields

developerModeCategory

Declaration
public const string developerModeCategory = "Developer Mode"
Field Value
Type Description
string

Methods

OnActivate(string, VisualElement)

Invoked by the SettingsProvider when activated in the Editor.

Declaration
public override void OnActivate(string searchContext, VisualElement rootElement)
Parameters
Type Name Description
string searchContext
VisualElement rootElement
Overrides

OnGUI(string)

Invoked by the Settings editor.

Declaration
public override void OnGUI(string searchContext)
Parameters
Type Name Description
string searchContext

A string containing the contents of the search bar.
Overrides

OnTitleBarGUI()

Invoked by the SettingsProvider container when drawing the UI header.

Declaration
public override void OnTitleBarGUI()
Overrides