IProfile

class mobase.IProfile

Bases: object

Interface to interact with Mod Organizer 2 profiles.

Methods Summary

`absoluteIniFilePath`(inifile)	Retrieve the absolute file path to the corresponding INI file for this profile.
`absolutePath`()	rtype: `str`
`invalidationActive`()	rtype: `tuple`
`localSavesEnabled`()	rtype: `bool`
`localSettingsEnabled`()	rtype: `bool`
`name`()	rtype: `str`

Methods Documentation

absoluteIniFilePath(inifile)

Retrieve the absolute file path to the corresponding INI file for this profile.

If iniFile does not correspond to a file in the list of INI files for the current game (as returned by IPluginGame::iniFiles), the path to the global file will be returned (if iniFile is absolute, iniFile is returned, otherwise the path is assumed relative to the game documents directory).

Return type:: str
Parameters:: inifile – INI file to retrieve a path for. This can either be the name of a file or a path to the absolute file outside of the profile.
Returns:: The absolute path for the given INI file for this profile.

absolutePath()

Return type:: str
Returns:: The absolute path to the profile folder.

invalidationActive()

Return type:: tuple
Returns:: True if automatic archive invalidation is enabled for this profile, False otherwise.

localSavesEnabled()

Return type:: bool
Returns:: True if profile-specific saves are enabled for this profile, False otherwise.

localSettingsEnabled()

Return type:: bool
Returns:: True if profile-specific game settings are enabled for this profile, False otherwise.

name()

Return type:: str
Returns:: The name of this profile.