RWESharp.Modify.Mod¶

Classes

`Mod`(manager, modinfo[, path])	Main part that changes RWE# todo make this part
`ModInfo`(title, id, author, version, ...)	ModInfo stores all information about the Mod

class RWESharp.Modify.Mod.ModInfo(title: str, id: str, author: str, version: str, description: str = 'No description provided', tags: list[str] = <factory>, required_modules: list[str] = <factory>, required_mods: list[str] = <factory>, mod_class: str = 'NOTFOUND')[source]¶

ModInfo stores all information about the Mod

Parameters:

title (str)
id (str)
author (str)
version (str)
description (str)
tags (list[str])
required_modules (list[str])
required_mods (list[str])
mod_class (str)

title: str¶: Mod Title

id: str¶: Mod Id

author: str¶: Mod Author

version: str¶: Mod Version

description: str = 'No description provided'¶: Mod Description

tags: list[str]¶: Mod Tags

required_modules: list[str]¶: Mod’s required Modules

required_mods: list[str]¶: Mod’s required Mods

mod_class: str = 'NOTFOUND'¶: Mod’s class to search through in mod’s script

static import_from_file(file: TextIOWrapper) → ModInfo | None[source]¶

Imports ModInfo from file

Parameters:: file (TextIOWrapper) – Json file
Returns:: ModInfo if found
Return type:: ModInfo

static import_from_mod_path(path) → ModInfo | None[source]¶

Imports file from mod’s path

Parameters:: path – Path to mod
Returns:: ModInfo if found
Return type:: ModInfo

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

Main part that changes RWE# todo make this part

Parameters:

manager (Manager)
modinfo (ModInfo)

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