Skip to content

Settings

Jump to bottom Edit New page
Jack Brookes edited this page Oct 31, 2020 · 11 revisions

UXF.Settings

Class which handles the cascading settings system. Wraps a Dictionary.

Fields

None

Properties

empty: Returns a new empty settings object.

baseDict: The underlying dictionary

Keys: The keys for the underlying dictionary

Item(System.String): Get a setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. If one is never found, it will return null.

Methods

UXF.Settings.UXF.Settings(System.Collections.Generic.Dictionary<string, object>)

Creates Settings instance from dictionary

Parameters

  • dict:

UXF.Settings.UXF.Settings()

Creates new empty Settings instance

Parameters

  • dict:

UXF.Settings.UpdateWithDict(System.Collections.Generic.Dictionary<string, object>)

Add all the keys and values from dict to the settings.

Parameters

  • dict: Dictionary to add.

UXF.Settings.SetParent(UXF.ISettingsContainer)

Sets the parent setting object, which is accessed when a setting is not found in the dictionary.

Parameters

  • parent:

UXF.Settings.GetBool(string)

Get a boolean setting value. If it is not found, the request will cascade upwards in each parent setting until one is found.

Parameters

  • key: The key (name) of the setting.

UXF.Settings.GetInt(string)

Get a integer setting value. If it is not found, the request will cascade upwards in each parent setting until one is found.

Parameters

  • key: The key (name) of the setting.

UXF.Settings.GetFloat(string)

Get a float setting value. If it is not found, the request will cascade upwards in each parent setting until one is found.

Parameters

  • key: The key (name) of the setting.

UXF.Settings.GetLong(string)

Get a long setting value. If it is not found, the request will cascade upwards in each parent setting until one is found.

Parameters

  • key: The key (name) of the setting.

UXF.Settings.GetDouble(string)

Get a double setting value. If it is not found, the request will cascade upwards in each parent setting until one is found.

Parameters

  • key: The key (name) of the setting.

UXF.Settings.GetString(string)

Get a string setting value. If it is not found, the request will cascade upwards in each parent setting until one is found.

Parameters

  • key: The key (name) of the setting.

UXF.Settings.GetDict(string)

Get a dictionary setting value. If it is not found, the request will cascade upwards in each parent setting until one is found.

Parameters

  • key: The key (name) of the setting.

UXF.Settings.GetObject(string)

Get a object setting value. If it is not found, the request will cascade upwards in each parent setting until one is found.

Parameters

  • key: The key (name) of the setting.

UXF.Settings.GetBoolList(string)

Get a boolean list setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. If the setting references a setting stored in the settings json file, a copy of the list will be returned. If it is a setting created with settings.SetValue(...), the original reference will be returned.

Parameters

  • key: The key (name) of the setting.

UXF.Settings.GetIntList(string)

Get a integer list setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. If the setting references a setting stored in the settings json file, a copy of the list will be returned. If it is a setting created with settings.SetValue(...), the original reference will be returned.

Parameters

  • key: The key (name) of the setting.

UXF.Settings.GetFloatList(string)

Get a float list setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. If the setting references a setting stored in the settings json file, a copy of the list will be returned. If it is a setting created with settings.SetValue(...), the original reference will be returned.

Parameters

  • key: The key (name) of the setting.

UXF.Settings.GetLongList(string)

Get a long list setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. If the setting references a setting stored in the settings json file, a copy of the list will be returned. If it is a setting created with settings.SetValue(...), the original reference will be returned.

Parameters

  • key: The key (name) of the setting.

UXF.Settings.GetDoubleList(string)

Get a double list setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. If the setting references a setting stored in the settings json file, a copy of the list will be returned. If it is a setting created with settings.SetValue(...), the original reference will be returned.

Parameters

  • key: The key (name) of the setting.

UXF.Settings.GetStringList(string)

Get a string list setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. If the setting references a setting stored in the settings json file, a copy of the list will be returned. If it is a setting created with settings.SetValue(...), the original reference will be returned.

Parameters

  • key: The key (name) of the setting.

UXF.Settings.GetObjectList(string)

Get a object list setting value. If it is not found, the request will cascade upwards in each parent setting until one is found.

Parameters

  • key: The key (name) of the setting.

UXF.Settings.GetBool(string, System.Boolean)

Get a boolean setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. Returns valueIfNotFound if the key is not found in the settings.

Parameters

  • key: The key (name) of the setting.

  • valueIfNotFound: The value returned if the setting does not exist (i.e., a default value).

UXF.Settings.GetInt(string, int)

Get a integer setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. Returns valueIfNotFound if the key is not found in the settings.

Parameters

  • key: The key (name) of the setting.

  • valueIfNotFound: The value returned if the setting does not exist (i.e., a default value).

UXF.Settings.GetFloat(string, float)

Get a float setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. Returns valueIfNotFound if the key is not found in the settings.

Parameters

  • key: The key (name) of the setting.

  • valueIfNotFound: The value returned if the setting does not exist (i.e., a default value).

UXF.Settings.GetLong(string, System.Int64)

Get a long setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. Returns valueIfNotFound if the key is not found in the settings.

Parameters

  • key: The key (name) of the setting.

  • valueIfNotFound: The value returned if the setting does not exist (i.e., a default value).

UXF.Settings.GetDouble(string, System.Double)

Get a double setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. Returns valueIfNotFound if the key is not found in the settings.

Parameters

  • key: The key (name) of the setting.

  • valueIfNotFound: The value returned if the setting does not exist (i.e., a default value).

UXF.Settings.GetString(string, string)

Get a string setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. Returns valueIfNotFound if the key is not found in the settings.

Parameters

  • key: The key (name) of the setting.

  • valueIfNotFound: The value returned if the setting does not exist (i.e., a default value).

UXF.Settings.GetDict(string, System.Collections.Generic.Dictionary<string, object>)

Get a dictionary setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. Returns valueIfNotFound if the key is not found in the settings.

Parameters

  • key: The key (name) of the setting.

  • valueIfNotFound: The value returned if the setting does not exist (i.e., a default value).

UXF.Settings.GetObject(string, object)

Get a object setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. Returns valueIfNotFound if the key is not found in the settings.

Parameters

  • key: The key (name) of the setting.

  • valueIfNotFound: The value returned if the setting does not exist (i.e., a default value).

UXF.Settings.GetBoolList(string, System.Collections.Generic.List<System.Boolean>)

Get a boolean list setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. Returns valueIfNotFound if the key is not found in the settings. If the setting references a setting stored in the settings json file, a copy of the list will be returned. If it is a setting created with settings.SetValue(...), the original reference will be returned.

Parameters

  • key: The key (name) of the setting.

  • valueIfNotFound: The value returned if the setting does not exist (i.e., a default value).

UXF.Settings.GetIntList(string, System.Collections.Generic.List<int>)

Get a integer list setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. If the setting references a setting stored in the settings json file, a copy of the list will be returned. If it is a setting created with settings.SetValue(...), the original reference will be returned.

Parameters

  • key: The key (name) of the setting.

  • valueIfNotFound: The value returned if the setting does not exist (i.e., a default value).

UXF.Settings.GetFloatList(string, System.Collections.Generic.List<float>)

Get a float list setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. If the setting references a setting stored in the settings json file, a copy of the list will be returned. If it is a setting created with settings.SetValue(...), the original reference will be returned.

Parameters

  • key: The key (name) of the setting.

  • valueIfNotFound: The value returned if the setting does not exist (i.e., a default value).

UXF.Settings.GetLongList(string, System.Collections.Generic.List<System.Int64>)

Get a long list setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. If the setting references a setting stored in the settings json file, a copy of the list will be returned. If it is a setting created with settings.SetValue(...), the original reference will be returned.

Parameters

  • key: The key (name) of the setting.

  • valueIfNotFound: The value returned if the setting does not exist (i.e., a default value).

UXF.Settings.GetDoubleList(string, System.Collections.Generic.List<System.Double>)

Get a double list setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. If the setting references a setting stored in the settings json file, a copy of the list will be returned. If it is a setting created with settings.SetValue(...), the original reference will be returned.

Parameters

  • key: The key (name) of the setting.

  • valueIfNotFound: The value returned if the setting does not exist (i.e., a default value).

UXF.Settings.GetStringList(string, System.Collections.Generic.List<string>)

Get a string list setting value. If it is not found, the request will cascade upwards in each parent setting until one is found. If the setting references a setting stored in the settings json file, a copy of the list will be returned. If it is a setting created with settings.SetValue(...), the original reference will be returned.

Parameters

  • key: The key (name) of the setting.

  • valueIfNotFound: The value returned if the setting does not exist (i.e., a default value).

UXF.Settings.GetObjectList(string, System.Collections.Generic.List<object>)

Get a object list setting value. If it is not found, the request will cascade upwards in each parent setting until one is found.

Parameters

  • key: The key (name) of the setting.

  • valueIfNotFound: The value returned if the setting does not exist (i.e., a default value).

UXF.Settings.SetValue(string, object)

Set a setting value.

Parameters

  • key: The key (name) of the setting.

  • value: The value of the setting.

Note: This file was automatically generated

⚠️ Have a problem not covered by the Wiki? Create an issue!

🧠 Core topics

❓ More help

👩‍💻 Programming reference

Unit tests

Clone this wiki locally