BaseMod.baseMod.BaseMod¶

class BaseMod.baseMod.BaseMod(manager, path)[source]¶

Bases: Mod

__init__(manager, path)[source]¶

Base Mod class to load

Parameters:

manager – manager to use
modinfo – mod info, should be filled with class
path – path to mod

Methods

`__init__`(manager, 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
`funnychanged`(value)
`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
`open_recent`(i)
`sexthing`()
`update_recent`()

Attributes

author_id

Returns string formatted as "author.id"

update_recent()[source]¶

open_recent(i)[source]¶

sexthing()[source]¶

funnychanged(value)[source]¶

on_save(viewport)[source]¶

Gets called before save

Returns:: None

level_opened(viewport: ViewPort)[source]¶

Gets called whenever user opens level

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

mount_levelparts(level)[source]¶

Used to mount all Mod’s LevelParts to level

Parameters:: level – Level to mount on
Returns:: None

close() → None[source]¶

Gets called when RWE# shuts down

Returns:: None
Return type:: None

add_config_module(config_module: ConfigModule) → None¶

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_editor(editor: Editor, ui: UI) → None¶

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_hotkey(hotkey: HotkeyElement) → None¶

Adds HotkeyTree to Hotkeys menu

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

add_quickview_option(element: QWidget) → None¶

Adds quick option in “Quick” tab

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

add_setting(setting: SettingElement) → None¶

Adds setting in Preferences menu

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

add_view(ui: ViewUI) → None¶

Adds View Ui to Manager

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

property author_id: str¶

Returns string formatted as “author.id”

Returns:: Formatted string
Return type:: str