RWESharp.Modify.Mod.Mod¶

class RWESharp.Modify.Mod.Mod(manager: Manager, modinfo: ModInfo, path='')[source]¶

Bases: ABC

Main part that changes RWE# todo make this part

Parameters:

manager (Manager)
modinfo (ModInfo)

__init__(manager: Manager, modinfo: ModInfo, path='')[source]¶

Base Mod class to load

Parameters:

manager (Manager) – manager to use
modinfo (ModInfo) – mod info, should be filled with class
path – path to mod

Methods

`__init__`(manager, modinfo[, path])	Base Mod class to load
`add_config_module`(config_module)	Adds Config module to Manager
`add_editor`(editor, ui)	Adds Editor to Manager, connected with ui
`add_hotkey`(hotkey)	Adds HotkeyTree to Hotkeys menu
`add_quickview_option`(element)	Adds quick option in "Quick" tab
`add_setting`(setting)	Adds setting in Preferences menu
`add_view`(ui)	Adds View Ui to Manager
`close`()	Gets called when RWE# shuts down
`level_opened`(viewport)	Gets called whenever user opens level
`mount_levelparts`(level)	Used to mount all Mod's LevelParts to level
`on_save`(viewport)	Gets called before save

Attributes

author_id

Returns string formatted as "author.id"

property author_id: str¶

Returns string formatted as “author.id”

Returns:: Formatted string
Return type:: str

add_editor(editor: Editor, ui: UI) → None[source]¶

Adds Editor to Manager, connected with ui

Parameters:

editor (Editor) – Editor to add
ui (UI) – Ui connected to editor

Returns:

None

Return type:

None

add_view(ui: ViewUI) → None[source]¶

Adds View Ui to Manager

Parameters:: ui (ViewUI) – View ui
Returns:: None
Return type:: None

add_quickview_option(element: QWidget) → None[source]¶

Adds quick option in “Quick” tab

Parameters:: element (QWidget) – Element to add
Returns:: None
Return type:: None

add_config_module(config_module: ConfigModule) → None[source]¶

Adds Config module to Manager

Called by ConfigModule automatically so you don’t need to use it

Parameters:: config_module (ConfigModule)
Returns:: None
Return type:: None

add_setting(setting: SettingElement) → None[source]¶

Adds setting in Preferences menu

Parameters:: setting (SettingElement) – Setting to add
Returns:: None
Return type:: None

add_hotkey(hotkey: HotkeyElement) → None[source]¶

Adds HotkeyTree to Hotkeys menu

Parameters:: hotkey (HotkeyElement) – Tree to add
Returns:: None
Return type:: None

on_save(viewport: ViewPort) → None[source]¶

Gets called before save

Returns:: None
Parameters:: viewport (ViewPort)
Return type:: None

level_opened(viewport: ViewPort) → None[source]¶

Gets called whenever user opens level

Parameters:: viewport (ViewPort) – viewport the level was opened in
Returns:: None
Return type:: None

mount_levelparts(level: RWELevel) → None[source]¶

Used to mount all Mod’s LevelParts to level

Parameters:: level (RWELevel) – Level to mount on
Returns:: None
Return type:: None

close() → None[source]¶

Gets called when RWE# shuts down

Returns:: None
Return type:: None