ScriptReference/SettingsProvider

[giscus[bot]]

ScriptReference/SettingsProvider

https://docs.unity3d.com/ScriptReference/SettingsProvider.html

[vertxxyz]

Creating project settings assets

Setup

To create a settings file in the Project Settings directory you can instead inherit your settings ScritableObject from ScriptableSingleton with a FilePath of ProjectSettings/Example.asset.

PropertyField issues

The following has been fixed as of 2022.3.7f1, 2023.1.7f1, and 2023.2.0b3.

The fields will not be editable, so you have to fix that, in OnActivate you can run some code like:

ExampleSettings settings = ExampleSettings.instance;
settings.hideFlags = HideFlags.DontSave | HideFlags.HideInHierarchy;
settings.Save();
_serializedObject = new SerializedObject(settings);

Changing its hideFlags so it's editable. And calling Save to force the asset to exist.
Save is a custom function that calls through to the protected Save:

public void Save() => Save(true);

Usage

Use _serializedObject as you would in any other Editor, but calling Save after ApplyModifiedProperties.

You should now have a .asset file in your ProjectSettings directory and a functioning SettingsProvider to display it.