Class ProjectUserSettings

Represents a settings repository that stores data local to a Unity project. The settings data is serialized to a JSON file.

Inheritance
Object
FileSettingsRepository
ProjectUserSettings
Inherited Members
Namespace: UnityEditor.SettingsManagement
Syntax
public class ProjectUserSettings : FileSettingsRepository, ISettingsRepository

Constructors

ProjectUserSettings(String, String)

Initializes and returns an instance of the ProjectUserSettings repository with the serialized data location set to a path defined by the specified package and name values relative to the UserSettings directory. For example: MyUnityProject/UserSettings/Packages/com.example.my-package/Settings.json.

Declaration
public ProjectUserSettings(string package, string name = "Settings")
Parameters
Type Name Description
String package

The name of the package to store the serialized data under.
String name

The base filename to use for the serialized data location (defaults to "Settings").

Methods

GetUserSettingsPath(String, String)

Builds and returns a path for a settings file relative to the calling assembly's package directory. This method constructs the location from the specified package and (filename) name under the UserSettings folder.

Declaration
public static string GetUserSettingsPath(string package, string name)
Parameters
Type Name Description
String package

The name of the package requesting this setting.
String name

An optional name for the settings file. Default is "Settings."
Returns
Type Description
String

A package-scoped path to the settings file inside the project's UserSettings folder.