UnmanagedMods
- class mobase.UnmanagedMods
Bases:
ABC
Methods Summary
displayName
(mod_name)Retrieve the display name of a given mod.
mods
(official_only)Retrieve the list of unmanaged mods for the corresponding game.
referenceFile
(mod_name)Retrieve the reference file for the requested mod.
secondaryFiles
(mod_name)Retrieve the secondary files for the requested mod.
Methods Documentation
- abstract displayName(mod_name)
Retrieve the display name of a given mod.
- Return type:
str
- Parameters:
mod_name – Internal name of the mod.
- Returns:
The display name of the mod.
- abstract mods(official_only)
Retrieve the list of unmanaged mods for the corresponding game.
- Return type:
Sequence
[str
]- Parameters:
official_only – Retrieve only unmanaged official mods.
- Returns:
The list of unmanaged mods (internal names).
- abstract referenceFile(mod_name)
Retrieve the reference file for the requested mod.
Example: For Bethesda games, the reference file may be the main plugin (esp or esm) for the game or a DLCs.
- Return type:
Union
[str
,PathLike
[str
],QFileInfo
]- Parameters:
mod_name – Internal name of the mod.
- Returns:
The reference file (absolute path) for the requested mod.
- abstract secondaryFiles(mod_name)
Retrieve the secondary files for the requested mod.
Example: For Bethesda games, the secondary files may be the archives corresponding to the reference file.
- Return type:
Sequence
[Union
[str
,PathLike
[str
],QFileInfo
]]- Parameters:
mod_name – Internal name of the mod.
- Returns:
The secondary files (absolute paths) for the request mod.