Skip to content
Jack Brookes edited this page Mar 23, 2019 · 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.SetParent(UXF.Settings)

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.

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.

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.

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.

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.

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.

Parameters

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

UXF.Settings.GetDictList(string)

Get a dictionary 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.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.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

๐Ÿง  Core topics

โ“ More help


๐Ÿ‘ฉโ€๐Ÿ’ป Programming reference

Unit tests

Clone this wiki locally