This commit is contained in:
Holt59
2024-08-01 12:18:49 +00:00
parent bf2a3ac61c
commit eeeab1c706
86 changed files with 134 additions and 773 deletions
+3 -18
View File
@@ -372,28 +372,13 @@
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.BSAInvalidation.activate" title="mobase.BSAInvalidation.activate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">activate</span></code></a>(profile)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.BSAInvalidation.deactivate" title="mobase.BSAInvalidation.deactivate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">deactivate</span></code></a>(profile)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.BSAInvalidation.isInvalidationBSA" title="mobase.BSAInvalidation.isInvalidationBSA"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isInvalidationBSA</span></code></a>(name)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
+6 -36
View File
@@ -372,52 +372,22 @@
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.ExecutableForcedLoadSetting.enabled" title="mobase.ExecutableForcedLoadSetting.enabled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">enabled</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.ExecutableForcedLoadSetting.forced" title="mobase.ExecutableForcedLoadSetting.forced"><code class="xref py py-obj docutils literal notranslate"><span class="pre">forced</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.ExecutableForcedLoadSetting.library" title="mobase.ExecutableForcedLoadSetting.library"><code class="xref py py-obj docutils literal notranslate"><span class="pre">library</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.ExecutableForcedLoadSetting.process" title="mobase.ExecutableForcedLoadSetting.process"><code class="xref py py-obj docutils literal notranslate"><span class="pre">process</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.ExecutableForcedLoadSetting.withEnabled" title="mobase.ExecutableForcedLoadSetting.withEnabled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">withEnabled</span></code></a>(enabled)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#mobase.ExecutableForcedLoadSetting" title="mobase.ExecutableForcedLoadSetting"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutableForcedLoadSetting</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.ExecutableForcedLoadSetting.withForced" title="mobase.ExecutableForcedLoadSetting.withForced"><code class="xref py py-obj docutils literal notranslate"><span class="pre">withForced</span></code></a>(forced)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#mobase.ExecutableForcedLoadSetting" title="mobase.ExecutableForcedLoadSetting"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutableForcedLoadSetting</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
+11 -66
View File
@@ -372,92 +372,37 @@
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.ExecutableInfo.arguments" title="mobase.ExecutableInfo.arguments"><code class="xref py py-obj docutils literal notranslate"><span class="pre">arguments</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.ExecutableInfo.asCustom" title="mobase.ExecutableInfo.asCustom"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asCustom</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#mobase.ExecutableInfo" title="mobase.ExecutableInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutableInfo</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.ExecutableInfo.binary" title="mobase.ExecutableInfo.binary"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binary</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">QFileInfo</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.ExecutableInfo.isCustom" title="mobase.ExecutableInfo.isCustom"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isCustom</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.ExecutableInfo.isValid" title="mobase.ExecutableInfo.isValid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isValid</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.ExecutableInfo.steamAppID" title="mobase.ExecutableInfo.steamAppID"><code class="xref py py-obj docutils literal notranslate"><span class="pre">steamAppID</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.ExecutableInfo.title" title="mobase.ExecutableInfo.title"><code class="xref py py-obj docutils literal notranslate"><span class="pre">title</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.ExecutableInfo.withArgument" title="mobase.ExecutableInfo.withArgument"><code class="xref py py-obj docutils literal notranslate"><span class="pre">withArgument</span></code></a>(argument)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#mobase.ExecutableInfo" title="mobase.ExecutableInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutableInfo</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.ExecutableInfo.withSteamAppId" title="mobase.ExecutableInfo.withSteamAppId"><code class="xref py py-obj docutils literal notranslate"><span class="pre">withSteamAppId</span></code></a>(app_id)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#mobase.ExecutableInfo" title="mobase.ExecutableInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutableInfo</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.ExecutableInfo.withWorkingDirectory" title="mobase.ExecutableInfo.withWorkingDirectory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">withWorkingDirectory</span></code></a>(directory)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#mobase.ExecutableInfo" title="mobase.ExecutableInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutableInfo</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.ExecutableInfo.workingDirectory" title="mobase.ExecutableInfo.workingDirectory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">workingDirectory</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">QDir</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
+5 -30
View File
@@ -396,50 +396,25 @@ represent a directory.</p>
<td><p>Detach this entry from its parent tree.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.FileTreeEntry.fileType" title="mobase.FileTreeEntry.fileType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fileType</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileTypes</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.FileTreeEntry.hasSuffix" title="mobase.FileTreeEntry.hasSuffix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hasSuffix</span></code></a>(**kwds)</p></td>
<td><p>Helper for &#64;overload to raise when called.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.FileTreeEntry.isDir" title="mobase.FileTreeEntry.isDir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isDir</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.FileTreeEntry.isFile" title="mobase.FileTreeEntry.isFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isFile</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.FileTreeEntry.moveTo" title="mobase.FileTreeEntry.moveTo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">moveTo</span></code></a>(tree)</p></td>
<td><p>Move this entry to the given tree.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.FileTreeEntry.name" title="mobase.FileTreeEntry.name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">name</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.FileTreeEntry.parent" title="mobase.FileTreeEntry.parent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">parent</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="mobase.IFileTree.html#mobase.IFileTree" title="mobase.IFileTree"><code class="xref py py-class docutils literal notranslate"><span class="pre">IFileTree</span></code></a> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.FileTreeEntry.path" title="mobase.FileTreeEntry.path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">path</span></code></a>([sep])</p></td>
<td><p>Retrieve the path from this entry up to the root of the tree.</p></td>
+5 -30
View File
@@ -372,44 +372,19 @@
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.GamePlugins.getLoadOrder" title="mobase.GamePlugins.getLoadOrder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getLoadOrder</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.GamePlugins.lightPluginsAreSupported" title="mobase.GamePlugins.lightPluginsAreSupported"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lightPluginsAreSupported</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.GamePlugins.overridePluginsAreSupported" title="mobase.GamePlugins.overridePluginsAreSupported"><code class="xref py py-obj docutils literal notranslate"><span class="pre">overridePluginsAreSupported</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.GamePlugins.readPluginLists" title="mobase.GamePlugins.readPluginLists"><code class="xref py py-obj docutils literal notranslate"><span class="pre">readPluginLists</span></code></a>(plugin_list)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.GamePlugins.writePluginLists" title="mobase.GamePlugins.writePluginLists"><code class="xref py py-obj docutils literal notranslate"><span class="pre">writePluginLists</span></code></a>(plugin_list)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
+1 -6
View File
@@ -387,12 +387,7 @@ class also allows a filter to be set. If a โ€œguessโ€ doesnโ€™t pass the filter
<td><p>Helper for &#64;overload to raise when called.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.GuessedString.variants" title="mobase.GuessedString.variants"><code class="xref py py-obj docutils literal notranslate"><span class="pre">variants</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
+1 -6
View File
@@ -381,12 +381,7 @@
<td><p>Extract the specified files from the currently opened archive to a temporary location.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IInstallationManager.getSupportedExtensions" title="mobase.IInstallationManager.getSupportedExtensions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getSupportedExtensions</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IInstallationManager.installArchive" title="mobase.IInstallationManager.installArchive"><code class="xref py py-obj docutils literal notranslate"><span class="pre">installArchive</span></code></a>(mod_name,ย archive[,ย mod_id])</p></td>
<td><p>Install the given archive.</p></td>
+20 -120
View File
@@ -372,12 +372,7 @@
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.absolutePath" title="mobase.IModInterface.absolutePath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">absolutePath</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.addCategory" title="mobase.IModInterface.addCategory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">addCategory</span></code></a>(name)</p></td>
<td><p>Assign a category to the mod.</p></td>
@@ -386,42 +381,22 @@
<td><p>Set the category id from a nexus category id.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.categories" title="mobase.IModInterface.categories"><code class="xref py py-obj docutils literal notranslate"><span class="pre">categories</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.clearPluginSettings" title="mobase.IModInterface.clearPluginSettings"><code class="xref py py-obj docutils literal notranslate"><span class="pre">clearPluginSettings</span></code></a>(plugin_name)</p></td>
<td><p>Remove all the settings of the specified plugin this mod.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.color" title="mobase.IModInterface.color"><code class="xref py py-obj docutils literal notranslate"><span class="pre">color</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">QColor</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.comments" title="mobase.IModInterface.comments"><code class="xref py py-obj docutils literal notranslate"><span class="pre">comments</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.converted" title="mobase.IModInterface.converted"><code class="xref py py-obj docutils literal notranslate"><span class="pre">converted</span></code></a>()</p></td>
<td><p>Check if the mod was marked as converted by the user.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.endorsedState" title="mobase.IModInterface.endorsedState"><code class="xref py py-obj docutils literal notranslate"><span class="pre">endorsedState</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="mobase.EndorsedState.html#mobase.EndorsedState" title="mobase.EndorsedState"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndorsedState</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.fileTree" title="mobase.IModInterface.fileTree"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fileTree</span></code></a>()</p></td>
<td><p>Retrieve a file tree corresponding to the underlying disk content of this mod.</p></td>
@@ -430,84 +405,34 @@
<td><p>Retrieve the short name of the game associated with this mod.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.ignoredVersion" title="mobase.IModInterface.ignoredVersion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ignoredVersion</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="mobase.VersionInfo.html#mobase.VersionInfo" title="mobase.VersionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.installationFile" title="mobase.IModInterface.installationFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">installationFile</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.isBackup" title="mobase.IModInterface.isBackup"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isBackup</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.isForeign" title="mobase.IModInterface.isForeign"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isForeign</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.isOverwrite" title="mobase.IModInterface.isOverwrite"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isOverwrite</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.isSeparator" title="mobase.IModInterface.isSeparator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isSeparator</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.name" title="mobase.IModInterface.name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">name</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.newestVersion" title="mobase.IModInterface.newestVersion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">newestVersion</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="mobase.VersionInfo.html#mobase.VersionInfo" title="mobase.VersionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.nexusId" title="mobase.IModInterface.nexusId"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nexusId</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.notes" title="mobase.IModInterface.notes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">notes</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.pluginSetting" title="mobase.IModInterface.pluginSetting"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pluginSetting</span></code></a>(plugin_name,ย key[,ย default])</p></td>
<td><p>Retrieve the specified setting in this mod for a plugin.</p></td>
@@ -516,23 +441,13 @@
<td><p>Retrieve the settings in this mod for a plugin.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.primaryCategory" title="mobase.IModInterface.primaryCategory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">primaryCategory</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.removeCategory" title="mobase.IModInterface.removeCategory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">removeCategory</span></code></a>(name)</p></td>
<td><p>Unassign a category from this mod.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.repository" title="mobase.IModInterface.repository"><code class="xref py py-obj docutils literal notranslate"><span class="pre">repository</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.setGameName" title="mobase.IModInterface.setGameName"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setGameName</span></code></a>(name)</p></td>
<td><p>Set the source game of this mod.</p></td>
@@ -556,31 +471,16 @@
<td><p>Set the version of this mod.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.trackedState" title="mobase.IModInterface.trackedState"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trackedState</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="mobase.TrackedState.html#mobase.TrackedState" title="mobase.TrackedState"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrackedState</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.url" title="mobase.IModInterface.url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">url</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.validated" title="mobase.IModInterface.validated"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validated</span></code></a>()</p></td>
<td><p>Check if the mod was marked as validated by the user.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.version" title="mobase.IModInterface.version"><code class="xref py py-obj docutils literal notranslate"><span class="pre">version</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="mobase.VersionInfo.html#mobase.VersionInfo" title="mobase.VersionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
+2 -12
View File
@@ -377,20 +377,10 @@ to translate from display name to internal name because the display name might n
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModList.allMods" title="mobase.IModList.allMods"><code class="xref py py-obj docutils literal notranslate"><span class="pre">allMods</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModList.allModsByProfilePriority" title="mobase.IModList.allModsByProfilePriority"><code class="xref py py-obj docutils literal notranslate"><span class="pre">allModsByProfilePriority</span></code></a>([profile])</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModList.displayName" title="mobase.IModList.displayName"><code class="xref py py-obj docutils literal notranslate"><span class="pre">displayName</span></code></a>(name)</p></td>
<td><p>Retrieve the display name of a mod from its internal name.</p></td>
+2 -12
View File
@@ -410,23 +410,13 @@
<td><p>Request download URL for mod file.0</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.requestFileInfo" title="mobase.IModRepositoryBridge.requestFileInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">requestFileInfo</span></code></a>(game_name,ย mod_id,ย file_id,ย ...)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.requestFiles" title="mobase.IModRepositoryBridge.requestFiles"><code class="xref py py-obj docutils literal notranslate"><span class="pre">requestFiles</span></code></a>(game_name,ย mod_id,ย user_data)</p></td>
<td><p>Request the list of files belonging to a mod.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModRepositoryBridge.requestToggleEndorsement" title="mobase.IModRepositoryBridge.requestToggleEndorsement"><code class="xref py py-obj docutils literal notranslate"><span class="pre">requestToggleEndorsement</span></code></a>(game_name,ย mod_id,ย ...)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
+13 -78
View File
@@ -374,20 +374,10 @@ of Mod Organizer to be used by plugins.</p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.appVersion" title="mobase.IOrganizer.appVersion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">appVersion</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="mobase.VersionInfo.html#mobase.VersionInfo" title="mobase.VersionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.basePath" title="mobase.IOrganizer.basePath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">basePath</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.createMod" title="mobase.IOrganizer.createMod"><code class="xref py py-obj docutils literal notranslate"><span class="pre">createMod</span></code></a>(name)</p></td>
<td><p>Create a new mod with the specified name.</p></td>
@@ -396,20 +386,10 @@ of Mod Organizer to be used by plugins.</p>
<td><p>Create a new Nexus interface.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.downloadManager" title="mobase.IOrganizer.downloadManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">downloadManager</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="mobase.IDownloadManager.html#mobase.IDownloadManager" title="mobase.IDownloadManager"><code class="xref py py-class docutils literal notranslate"><span class="pre">IDownloadManager</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.downloadsPath" title="mobase.IOrganizer.downloadsPath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">downloadsPath</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.findFileInfos" title="mobase.IOrganizer.findFileInfos"><code class="xref py py-obj docutils literal notranslate"><span class="pre">findFileInfos</span></code></a>(path,ย filter)</p></td>
<td><p>Find files in the virtual directory matching the specified filter.</p></td>
@@ -424,12 +404,7 @@ of Mod Organizer to be used by plugins.</p>
<td><p>Retrieve the game plugin matching the given name.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.getPluginDataPath" title="mobase.IOrganizer.getPluginDataPath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getPluginDataPath</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.installMod" title="mobase.IOrganizer.installMod"><code class="xref py py-obj docutils literal notranslate"><span class="pre">installMod</span></code></a>(filename[,ย name_suggestion])</p></td>
<td><p>Install a mod archive at the specified location.</p></td>
@@ -441,31 +416,16 @@ of Mod Organizer to be used by plugins.</p>
<td><p>Retrieve the list of (virtual) subdirectories in the given path.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.managedGame" title="mobase.IOrganizer.managedGame"><code class="xref py py-obj docutils literal notranslate"><span class="pre">managedGame</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="mobase.IPluginGame.html#mobase.IPluginGame" title="mobase.IPluginGame"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPluginGame</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.modDataChanged" title="mobase.IOrganizer.modDataChanged"><code class="xref py py-obj docutils literal notranslate"><span class="pre">modDataChanged</span></code></a>(mod)</p></td>
<td><p>Notify the organizer that the given mod has changed.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.modList" title="mobase.IOrganizer.modList"><code class="xref py py-obj docutils literal notranslate"><span class="pre">modList</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="mobase.IModList.html#mobase.IModList" title="mobase.IModList"><code class="xref py py-class docutils literal notranslate"><span class="pre">IModList</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.modsPath" title="mobase.IOrganizer.modsPath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">modsPath</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.onAboutToRun" title="mobase.IOrganizer.onAboutToRun"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onAboutToRun</span></code></a>(**kwds)</p></td>
<td><p>Helper for &#64;overload to raise when called.</p></td>
@@ -501,12 +461,7 @@ of Mod Organizer to be used by plugins.</p>
<td><p>Install a new handler to be called when the UI has been fully initialized.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.overwritePath" title="mobase.IOrganizer.overwritePath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">overwritePath</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.persistent" title="mobase.IOrganizer.persistent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">persistent</span></code></a>(plugin_name,ย key[,ย default])</p></td>
<td><p>Retrieve the specified persistent value for a plugin.</p></td>
@@ -515,39 +470,19 @@ of Mod Organizer to be used by plugins.</p>
<td><p>Retrieve the path to a directory where plugin data should be stored.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.pluginList" title="mobase.IOrganizer.pluginList"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pluginList</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="mobase.IPluginList.html#mobase.IPluginList" title="mobase.IPluginList"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPluginList</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.pluginSetting" title="mobase.IOrganizer.pluginSetting"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pluginSetting</span></code></a>(plugin_name,ย key)</p></td>
<td><p>Retrieve settings of plugins.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.profile" title="mobase.IOrganizer.profile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">profile</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="mobase.IProfile.html#mobase.IProfile" title="mobase.IProfile"><code class="xref py py-class docutils literal notranslate"><span class="pre">IProfile</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.profileName" title="mobase.IOrganizer.profileName"><code class="xref py py-obj docutils literal notranslate"><span class="pre">profileName</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.profilePath" title="mobase.IOrganizer.profilePath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">profilePath</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.refresh" title="mobase.IOrganizer.refresh"><code class="xref py py-obj docutils literal notranslate"><span class="pre">refresh</span></code></a>([save_changes])</p></td>
<td><p>Refresh the internal mods file structure from disk.</p></td>
+4 -24
View File
@@ -373,20 +373,10 @@
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPlugin.author" title="mobase.IPlugin.author"><code class="xref py py-obj docutils literal notranslate"><span class="pre">author</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPlugin.description" title="mobase.IPlugin.description"><code class="xref py py-obj docutils literal notranslate"><span class="pre">description</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPlugin.enabledByDefault" title="mobase.IPlugin.enabledByDefault"><code class="xref py py-obj docutils literal notranslate"><span class="pre">enabledByDefault</span></code></a>()</p></td>
<td><p>Check whether this plugin should be enabled by default.</p></td>
@@ -407,20 +397,10 @@
<td><p>Retrieve the requirements for this plugin.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPlugin.settings" title="mobase.IPlugin.settings"><code class="xref py py-obj docutils literal notranslate"><span class="pre">settings</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="mobase.PluginSetting.html#mobase.PluginSetting" title="mobase.PluginSetting"><code class="xref py py-class docutils literal notranslate"><span class="pre">PluginSetting</span></code></a>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPlugin.version" title="mobase.IPlugin.version"><code class="xref py py-obj docutils literal notranslate"><span class="pre">version</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="mobase.VersionInfo.html#mobase.VersionInfo" title="mobase.VersionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
+1 -6
View File
@@ -373,12 +373,7 @@
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginFileMapper.mappings" title="mobase.IPluginFileMapper.mappings"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mappings</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="mobase.Mapping.html#mobase.Mapping" title="mobase.Mapping"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code></a>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
+22 -132
View File
@@ -377,71 +377,31 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.CCPlugins" title="mobase.IPluginGame.CCPlugins"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CCPlugins</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.DLCPlugins" title="mobase.IPluginGame.DLCPlugins"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DLCPlugins</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.binaryName" title="mobase.IPluginGame.binaryName"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryName</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.dataDirectory" title="mobase.IPluginGame.dataDirectory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dataDirectory</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">QDir</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.detectGame" title="mobase.IPluginGame.detectGame"><code class="xref py py-obj docutils literal notranslate"><span class="pre">detectGame</span></code></a>()</p></td>
<td><p>Detect the game.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.documentsDirectory" title="mobase.IPluginGame.documentsDirectory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">documentsDirectory</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">QDir</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.enabledPlugins" title="mobase.IPluginGame.enabledPlugins"><code class="xref py py-obj docutils literal notranslate"><span class="pre">enabledPlugins</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.executableForcedLoads" title="mobase.IPluginGame.executableForcedLoads"><code class="xref py py-obj docutils literal notranslate"><span class="pre">executableForcedLoads</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="mobase.ExecutableForcedLoadSetting.html#mobase.ExecutableForcedLoadSetting" title="mobase.ExecutableForcedLoadSetting"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutableForcedLoadSetting</span></code></a>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.executables" title="mobase.IPluginGame.executables"><code class="xref py py-obj docutils literal notranslate"><span class="pre">executables</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="mobase.ExecutableInfo.html#mobase.ExecutableInfo" title="mobase.ExecutableInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutableInfo</span></code></a>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.feature" title="mobase.IPluginGame.feature"><code class="xref py py-obj docutils literal notranslate"><span class="pre">feature</span></code></a>(feature_type)</p></td>
<td><p>Retrieve a specified game feature from this plugin.</p></td>
@@ -450,101 +410,46 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
<td><p>Retrieve the list of game features implemented for this plugin.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.gameDirectory" title="mobase.IPluginGame.gameDirectory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gameDirectory</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">QDir</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.gameIcon" title="mobase.IPluginGame.gameIcon"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gameIcon</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">QIcon</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.gameName" title="mobase.IPluginGame.gameName"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gameName</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.gameNexusName" title="mobase.IPluginGame.gameNexusName"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gameNexusName</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.gameShortName" title="mobase.IPluginGame.gameShortName"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gameShortName</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.gameVariants" title="mobase.IPluginGame.gameVariants"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gameVariants</span></code></a>()</p></td>
<td><p>Retrieve the list of variants for this game.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.gameVersion" title="mobase.IPluginGame.gameVersion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gameVersion</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.getLauncherName" title="mobase.IPluginGame.getLauncherName"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getLauncherName</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.getSupportURL" title="mobase.IPluginGame.getSupportURL"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getSupportURL</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.iniFiles" title="mobase.IPluginGame.iniFiles"><code class="xref py py-obj docutils literal notranslate"><span class="pre">iniFiles</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.initializeProfile" title="mobase.IPluginGame.initializeProfile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">initializeProfile</span></code></a>(directory,ย settings)</p></td>
<td><p>Initialize a profile for this game.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.isInstalled" title="mobase.IPluginGame.isInstalled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isInstalled</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.listSaves" title="mobase.IPluginGame.listSaves"><code class="xref py py-obj docutils literal notranslate"><span class="pre">listSaves</span></code></a>(folder)</p></td>
<td><p>List saves in the given directory.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.loadOrderMechanism" title="mobase.IPluginGame.loadOrderMechanism"><code class="xref py py-obj docutils literal notranslate"><span class="pre">loadOrderMechanism</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="mobase.LoadOrderMechanism.html#mobase.LoadOrderMechanism" title="mobase.LoadOrderMechanism"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadOrderMechanism</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.looksValid" title="mobase.IPluginGame.looksValid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">looksValid</span></code></a>(directory)</p></td>
<td><p>Check if the given directory looks like a valid game installation.</p></td>
@@ -556,23 +461,13 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
<td><p>Retrieve the Nexus mod ID of Mod Organizer for this game.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.primaryPlugins" title="mobase.IPluginGame.primaryPlugins"><code class="xref py py-obj docutils literal notranslate"><span class="pre">primaryPlugins</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.primarySources" title="mobase.IPluginGame.primarySources"><code class="xref py py-obj docutils literal notranslate"><span class="pre">primarySources</span></code></a>()</p></td>
<td><p>Retrieve primary alternative 'short' names for this game.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.savesDirectory" title="mobase.IPluginGame.savesDirectory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">savesDirectory</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">QDir</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.secondaryDataDirectories" title="mobase.IPluginGame.secondaryDataDirectories"><code class="xref py py-obj docutils literal notranslate"><span class="pre">secondaryDataDirectories</span></code></a>()</p></td>
<td><p>Retrieve the list of secondary data directories.</p></td>
@@ -584,12 +479,7 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
<td><p>Set the game variant.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.sortMechanism" title="mobase.IPluginGame.sortMechanism"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sortMechanism</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="mobase.SortMechanism.html#mobase.SortMechanism" title="mobase.SortMechanism"><code class="xref py py-class docutils literal notranslate"><span class="pre">SortMechanism</span></code></a></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.steamAPPId" title="mobase.IPluginGame.steamAPPId"><code class="xref py py-obj docutils literal notranslate"><span class="pre">steamAPPId</span></code></a>()</p></td>
<td><p>Retrieve the Steam app ID for this game.</p></td>
+1 -6
View File
@@ -381,12 +381,7 @@ from there. They have to be able to extract the archive themselves.</p>
<td><p>Helper for &#64;overload to raise when called.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginInstallerCustom.supportedExtensions" title="mobase.IPluginInstallerCustom.supportedExtensions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">supportedExtensions</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
+1 -6
View File
@@ -403,12 +403,7 @@
<td><p>Retrieve the origin of a plugin.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginList.pluginNames" title="mobase.IPluginList.pluginNames"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pluginNames</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginList.priority" title="mobase.IPluginList.priority"><code class="xref py py-obj docutils literal notranslate"><span class="pre">priority</span></code></a>(name)</p></td>
<td><p>Retrieve the priority of a plugin.</p></td>
+3 -18
View File
@@ -372,31 +372,16 @@
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginModPage.displayName" title="mobase.IPluginModPage.displayName"><code class="xref py py-obj docutils literal notranslate"><span class="pre">displayName</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginModPage.handlesDownload" title="mobase.IPluginModPage.handlesDownload"><code class="xref py py-obj docutils literal notranslate"><span class="pre">handlesDownload</span></code></a>(page_url,ย download_url,ย fileinfo)</p></td>
<td><p>Check if the plugin handles the specified download.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginModPage.icon" title="mobase.IPluginModPage.icon"><code class="xref py py-obj docutils literal notranslate"><span class="pre">icon</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">QIcon</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginModPage.pageURL" title="mobase.IPluginModPage.pageURL"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pageURL</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">QUrl</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginModPage.setParentWidget" title="mobase.IPluginModPage.setParentWidget"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setParentWidget</span></code></a>(parent)</p></td>
<td><p>Set the parent widget for this mod page.</p></td>
+1 -6
View File
@@ -377,12 +377,7 @@ by qt are implemented (including dds) but no audio files and no 3d mesh formats.
<td><p>Generate a preview for the specified file.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginPreview.supportedExtensions" title="mobase.IPluginPreview.supportedExtensions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">supportedExtensions</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
+3 -18
View File
@@ -381,31 +381,16 @@ application itself.</p>
<td><p>Called when the user starts the tool.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginTool.displayName" title="mobase.IPluginTool.displayName"><code class="xref py py-obj docutils literal notranslate"><span class="pre">displayName</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginTool.icon" title="mobase.IPluginTool.icon"><code class="xref py py-obj docutils literal notranslate"><span class="pre">icon</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">QIcon</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginTool.setParentWidget" title="mobase.IPluginTool.setParentWidget"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setParentWidget</span></code></a>(parent)</p></td>
<td><p>Set the parent widget for this tool.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginTool.tooltip" title="mobase.IPluginTool.tooltip"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tooltip</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
+5 -30
View File
@@ -376,44 +376,19 @@
<td><p>Retrieve the absolute file path to the corresponding INI file for this profile.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IProfile.absolutePath" title="mobase.IProfile.absolutePath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">absolutePath</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IProfile.invalidationActive" title="mobase.IProfile.invalidationActive"><code class="xref py py-obj docutils literal notranslate"><span class="pre">invalidationActive</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IProfile.localSavesEnabled" title="mobase.IProfile.localSavesEnabled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">localSavesEnabled</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IProfile.localSettingsEnabled" title="mobase.IProfile.localSettingsEnabled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">localSettingsEnabled</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IProfile.name" title="mobase.IProfile.name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">name</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>

Some files were not shown because too many files have changed in this diff Show More