Class UserSettingsRepository

A settings repository backed by the UnityEditor.EditorPrefs class.

Inheritance
Object
UserSettingsRepository
Namespace: UnityEditor.SettingsManagement
Syntax
public class UserSettingsRepository : ISettingsRepository

Properties

name

An identifying name for this repository. User settings are named "EditorPrefs."

Declaration
public string name { get; }
Property Value
Type Description
String
Implements

path

Declaration
public string path { get; }
Property Value
Type Description
String

File path to the serialized settings data.
Implements
Remarks

This property returns an empty string.

scope

Declaration
public SettingsScope scope { get; }
Property Value
Type Description
SettingsScope

What SettingsScope this repository applies to.
Implements

Methods

ContainsKey<T>(String)

Does the repository contain a setting with key and type.

Declaration
public bool ContainsKey<T>(string key)
Parameters
Type Name Description
String key

The settings key.
Returns
Type Description
Boolean

True if a setting matching both key and type is found, false if no entry is found.
Type Parameters
Name Description
T

The type of value to search for.
Implements

Get<T>(String, T)

Get a value with key of type T, or return the fallback value if no matching key is found.

Declaration
public T Get<T>(string key, T fallback = null)
Parameters
Type Name Description
String key

The settings key.
T fallback

If no key with a value of type T is found, this value is returned.
Returns
Type Description
T
Type Parameters
Name Description
T

Type of value to search for.
Implements

Remove<T>(String)

Remove a key value pair from the settings repository.

Declaration
public void Remove<T>(string key)
Parameters
Type Name Description
String key
Type Parameters
Name Description
T
Implements

Save()

Save all settings to their serialized state.

Declaration
public void Save()
Implements

Set<T>(String, T)

Set a value for key of type T.

Declaration
public void Set<T>(string key, T value)
Parameters
Type Name Description
String key

The settings key.
T value

The value to set. Must be serializable.
Type Parameters
Name Description
T

Type of value.
Implements