RWESharp.Modify.Ui¶

Classes

`SettingUI`(mod)	SettingUI is UI for Preferences menu todo add more
`ThemeUI`(theme[, parent])	Ui for custom Themes todo add more
`UI`(mod[, parent])	UI base for creating Editor UI's todo add more
`ViewUI`(mod[, parent])	Addition to UI that allows to create View tabs todo add more

class RWESharp.Modify.Ui.UI(mod: Mod, parent=None)[source]¶

UI base for creating Editor UI’s todo add more

Parameters:: mod (Mod)

begin_recording() → None[source]¶

Records all of your actions if Debug mode is set

Returns:: None
Return type:: None

editor_linked(editor) → None[source]¶

Gets called whenever Editor with this UI is being added

Parameters:: editor – Editor that was added
Returns:: None
Return type:: None

property basemod: BaseMod¶

property selected_viewport: ViewPort¶

property level: RWELevel¶

property level_loaded: bool¶

Returns if level was loaded

Returns:: if viewport is available
Return type:: bool

staticMetaObject = PySide6.QtCore.QMetaObject("UI" inherits "QWidget": )¶

class RWESharp.Modify.Ui.ViewUI(mod: Mod, parent=None)[source]¶

Addition to UI that allows to create View tabs todo add more

Parameters:: mod (Mod)

add_myself() → ViewUI[source]¶

Adds ViewUI to View tab

Returns:: self
Return type:: ViewUI

staticMetaObject = PySide6.QtCore.QMetaObject("ViewUI" inherits "UI": )¶

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

SettingUI is UI for Preferences menu todo add more

Parameters:: mod (Mod)

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]¶

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

class RWESharp.Modify.Ui.ThemeUI(theme: Theme, parent=None)[source]¶

Ui for custom Themes todo add more

Parameters:: theme (Theme)

abstractmethod setup_ui(viewer)[source]¶

staticMetaObject = PySide6.QtCore.QMetaObject("ThemeUI" inherits "UI": )¶