RWESharp.Modify.Ui.SettingUI¶

class RWESharp.Modify.Ui.SettingUI(mod: Mod)[source]¶

Bases: ABC

SettingUI is UI for Preferences menu todo add more

Parameters:: mod (Mod)

Parameters:: mod (Mod)

Methods

`__init__`(mod)
`apply_values`()	Called when values need to be applied
`init_ui`(viewer)	Called when ui is being initiated
`reset_values`()	Called when values need to be reset to the saved ones
`reset_values_default`()	Called when values need to be reset to default

Attributes

`basemod`
`is_changed`	Returns whenever settings values were changed

abstractmethod init_ui(viewer: SettingsViewer) → None[source]¶

Called when ui is being initiated

Parameters:: viewer (SettingsViewer) – SettingsViewer
Returns:: None
Return type:: None

reset_values()[source]¶

Called when values need to be reset to the saved ones

Returns:: None

reset_values_default()[source]¶

Called when values need to be reset to default

Returns:: None

apply_values()[source]¶

Called when values need to be applied

Returns:: None

property is_changed¶

Returns whenever settings values were changed

Returns:: If settings were changed
Return type:: bool

property basemod: BaseMod¶

class ManageableSetting(setting: Configurable | None = None, source: Configurable | None = None, source2setting=<function SettingUI.ManageableSetting.<lambda>>, setting2source=<function SettingUI.ManageableSetting.<lambda>>)[source]¶

Bases: object

todo this

Parameters:

setting (Configurable | None)
source (Configurable | None)

source2setting() → None[source]¶

Updated default value of source Configurable to settings Configurable

Returns:: None
Return type:: None

setting2source() → None[source]¶

Updated default value of setting Configurable to sources Configurable

Returns:: None
Return type:: None

reset_values_default() → None[source]¶

Reset settings value

Returns:: None
Return type:: None

apply_setting() → None[source]¶

Applies new settings value as settings default

Returns:: None
Return type:: None

add_myself(settingui: SettingUI) → ManageableSetting[source]¶

Adds itself onto Settings Ui

Parameters:: settingui (SettingUI) – Ui to add to
Returns:: self
Return type:: SettingUI.ManageableSetting

property value¶

Settings value

Returns:: Value