Interface ISettingsManager

Namespace: SociallyDistant.Core.Core.Config

Assembly: SociallyDistant.Framework.dll

Syntax

public interface ISettingsManager

Properties

GameDataPath

Declaration

string GameDataPath { get; }

Property Value

Type	Description
string

IsInitialized

Declaration

bool IsInitialized { get; }

Property Value

Type	Description
bool

Keys

Declaration

IEnumerable<string> Keys { get; }

Property Value

Type	Description
IEnumerable<string>

SectionTitles

Declaration

IEnumerable<string> SectionTitles { get; }

Property Value

Type	Description
IEnumerable<string>

Methods

FindSettingsByKey(string)

Declaration

SettingsCategory? FindSettingsByKey(string key)

Parameters

Type	Name	Description
string	key

Returns

Type	Description
SettingsCategory

FindSettings<T>()

Declaration

T? FindSettings<T>() where T : SettingsCategory

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetBool(string, bool)

Declaration

bool GetBool(string key, bool defaultValue = false)

Parameters

Type	Name	Description
string	key
bool	defaultValue

Returns

Type	Description
bool

GetCategoriesInSection(string)

Declaration

IEnumerable<SettingsCategory> GetCategoriesInSection(string sectionTitle)

Parameters

Type	Name	Description
string	sectionTitle

Returns

Type	Description
IEnumerable<SettingsCategory>

GetFloat(string, float)

Declaration

float GetFloat(string key, float defaultValue = 0)

Parameters

Type	Name	Description
string	key
float	defaultValue

Returns

Type	Description
float

GetInt(string, int)

Declaration

int GetInt(string key, int defaultValue = 0)

Parameters

Type	Name	Description
string	key
int	defaultValue

Returns

Type	Description
int

GetString(string, string?)

Declaration

string? GetString(string key, string? defaultValue = null)

Parameters

Type	Name	Description
string	key
string	defaultValue

Returns

Type	Description
string

HasKey(string)

Declaration

bool HasKey(string key)

Parameters

Type	Name	Description
string	key

Returns

Type	Description
bool

IsBool(string)

Declaration

bool IsBool(string key)

Parameters

Type	Name	Description
string	key

Returns

Type	Description
bool

IsFloat(string)

Declaration

bool IsFloat(string key)

Parameters

Type	Name	Description
string	key

Returns

Type	Description
bool

IsInt(string)

Declaration

bool IsInt(string key)

Parameters

Type	Name	Description
string	key

Returns

Type	Description
bool

IsString(string)

Declaration

bool IsString(string key)

Parameters

Type	Name	Description
string	key

Returns

Type	Description
bool

Load()

Declaration

void Load()

ObserveChanges(Action<ISettingsManager>)

Declaration

IDisposable ObserveChanges(Action<ISettingsManager> onUpdate)

Parameters

Type	Name	Description
Action<ISettingsManager>	onUpdate

Returns

Type	Description
IDisposable

RegisterSettingsCategory<T>()

Declaration

T RegisterSettingsCategory<T>() where T : SettingsCategory

Returns

Type	Description
T

Type Parameters

Name	Description
T

ResetKey(string)

Declaration

void ResetKey(string key)

Parameters

Type	Name	Description
string	key

Save()

Declaration

void Save()

SetBool(string, bool)

Declaration

void SetBool(string key, bool value)

Parameters

Type	Name	Description
string	key
bool	value

SetFloat(string, float)

Declaration

void SetFloat(string key, float value)

Parameters

Type	Name	Description
string	key
float	value

SetInt(string, int)

Declaration

void SetInt(string key, int value)

Parameters

Type	Name	Description
string	key
int	value

SetString(string, string?)

Declaration

void SetString(string key, string? value)

Parameters

Type	Name	Description
string	key
string	value

UnregisterSettingsCategory(SettingsCategory)

Declaration

void UnregisterSettingsCategory(SettingsCategory category)

Parameters

Type	Name	Description
SettingsCategory	category