Interface ISettingsRepository

A settings repository is responsible for implementing the saving and loading of values.

Namespace: UnityEditor.SettingsManagement

Assembly: Unity.Settings.Editor.dll

Syntax

public interface ISettingsRepository

Properties

name

A name to identify this repository.

Declaration

string name { get; }

Property Value

Type	Description
string

path

Declaration

string path { get; }

Property Value

Type	Description
string	File path to the serialized settings data.

scope

Declaration

SettingsScope scope { get; }

Property Value

Type	Description
SettingsScope	What SettingsScope this repository applies to.

Methods

ContainsKey<T>(string)

Does the repository contain a setting with key and type.

Declaration

bool ContainsKey<T>(string key)

Parameters

Type	Name	Description
string	key	The settings key.

Returns

Type	Description
bool	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.

Get<T>(string, T)

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

Declaration

T Get<T>(string key, T fallback = default)

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.

Remove<T>(string)

Remove a key value pair from the settings repository.

Declaration

void Remove<T>(string key)

Parameters

Type	Name	Description
string	key

Type Parameters

Name	Description
T

Save()

Save all settings to their serialized state.

Declaration

void Save()

Set<T>(string, T)

Set a value for key of type T.

Declaration

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.