mo2/python-plugins-doc
0
0
Fork 0
mirror of https://github.com/ModOrganizer2/python-plugins-doc.git synced 2026-07-27 14:07:44 -07:00
Code Issues Packages Projects Releases Wiki Activity

Deploying to master from @ ModOrganizer2/pystubs-generation@ece93e7cb3 πŸš€

Browse Source
This commit is contained in:
Holt59
2023-10-04 17:28:25 +00:00
parent b8263dfda7
commit 70ff5d331b
10 changed files with 126 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.doctrees/api/mobase.IOrganizer.doctree
BIN
View File
Binary file not shown.
.doctrees/api/mobase.IPluginGame.doctree
BIN
View File
Binary file not shown.
.doctrees/environment.pickle
BIN
View File
Binary file not shown.
_sources/api/mobase.IOrganizer.rst.txt
+2
View File
@@ -30,6 +30,7 @@ IOrganizer
~IOrganizer.modsPath
~IOrganizer.onAboutToRun
~IOrganizer.onFinishedRun
~IOrganizer.onNextRefresh
~IOrganizer.onPluginDisabled
~IOrganizer.onPluginEnabled
~IOrganizer.onPluginSettingChanged
@@ -76,6 +77,7 @@ IOrganizer
.. automethod:: modsPath
.. automethod:: onAboutToRun
.. automethod:: onFinishedRun
.. automethod:: onNextRefresh
.. automethod:: onPluginDisabled
.. automethod:: onPluginEnabled
.. automethod:: onPluginSettingChanged
_sources/api/mobase.IPluginGame.rst.txt
+2
View File
@@ -16,6 +16,7 @@ IPluginGame
~IPluginGame.dataDirectory
~IPluginGame.detectGame
~IPluginGame.documentsDirectory
~IPluginGame.enabledPlugins
~IPluginGame.executableForcedLoads
~IPluginGame.executables
~IPluginGame.feature
@@ -55,6 +56,7 @@ IPluginGame
.. automethod:: dataDirectory
.. automethod:: detectGame
.. automethod:: documentsDirectory
.. automethod:: enabledPlugins
.. automethod:: executableForcedLoads
.. automethod:: executables
.. automethod:: feature
api/mobase.IOrganizer.html
+53 -42
View File
@@ -465,37 +465,40 @@ of Mod Organizer to be used by plugins.</p>
</dl>
</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>(callback)</p></td>
<td><p>Install a new handler to be called when an application is about to run.</p></td>
<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>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.onFinishedRun" title="mobase.IOrganizer.onFinishedRun"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onFinishedRun</span></code></a>(callback)</p></td>
<td><p>Install a new handler to be called when an application has finished running.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.onPluginDisabled" title="mobase.IOrganizer.onPluginDisabled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onPluginDisabled</span></code></a>(**kwds)</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.onNextRefresh" title="mobase.IOrganizer.onNextRefresh"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onNextRefresh</span></code></a>(callback[,Β immediate_if_possible])</p></td>
<td><p>Install a new handler to be called on the next refresh or immediately.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.onPluginDisabled" title="mobase.IOrganizer.onPluginDisabled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onPluginDisabled</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.IOrganizer.onPluginEnabled" title="mobase.IOrganizer.onPluginEnabled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onPluginEnabled</span></code></a>(**kwds)</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.onPluginEnabled" title="mobase.IOrganizer.onPluginEnabled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onPluginEnabled</span></code></a>(**kwds)</p></td>
<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.IOrganizer.onPluginSettingChanged" title="mobase.IOrganizer.onPluginSettingChanged"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onPluginSettingChanged</span></code></a>(callback)</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.onPluginSettingChanged" title="mobase.IOrganizer.onPluginSettingChanged"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onPluginSettingChanged</span></code></a>(callback)</p></td>
<td><p>Install a new handler to be called when a plugin setting is changed.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.onProfileChanged" title="mobase.IOrganizer.onProfileChanged"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onProfileChanged</span></code></a>(callback)</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.onProfileChanged" title="mobase.IOrganizer.onProfileChanged"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onProfileChanged</span></code></a>(callback)</p></td>
<td><p>Install a new handler to be called when the current profile is changed.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.onProfileCreated" title="mobase.IOrganizer.onProfileCreated"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onProfileCreated</span></code></a>(callback)</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.onProfileCreated" title="mobase.IOrganizer.onProfileCreated"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onProfileCreated</span></code></a>(callback)</p></td>
<td><p>Install a new handler to be called when a new profile is created.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.onProfileRemoved" title="mobase.IOrganizer.onProfileRemoved"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onProfileRemoved</span></code></a>(callback)</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.onProfileRemoved" title="mobase.IOrganizer.onProfileRemoved"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onProfileRemoved</span></code></a>(callback)</p></td>
<td><p>Install a new handler to be called when a profile is remove.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.onProfileRenamed" title="mobase.IOrganizer.onProfileRenamed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onProfileRenamed</span></code></a>(callback)</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.onProfileRenamed" title="mobase.IOrganizer.onProfileRenamed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onProfileRenamed</span></code></a>(callback)</p></td>
<td><p>Install a new handler to be called when a profile is renamed.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.onUserInterfaceInitialized" title="mobase.IOrganizer.onUserInterfaceInitialized"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onUserInterfaceInitialized</span></code></a>(callback)</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.onUserInterfaceInitialized" title="mobase.IOrganizer.onUserInterfaceInitialized"><code class="xref py py-obj docutils literal notranslate"><span class="pre">onUserInterfaceInitialized</span></code></a>(callback)</p></td>
<td><p>Install a new handler to be called when the UI has been fully initialized.</p></td>
</tr>
<tr class="row-odd"><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>
<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><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
@@ -503,13 +506,13 @@ of Mod Organizer to be used by plugins.</p>
</dl>
</p></td>
</tr>
<tr class="row-even"><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>
<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>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.pluginDataPath" title="mobase.IOrganizer.pluginDataPath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pluginDataPath</span></code></a>()</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.pluginDataPath" title="mobase.IOrganizer.pluginDataPath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pluginDataPath</span></code></a>()</p></td>
<td><p>Retrieve the path to a directory where plugin data should be stored.</p></td>
</tr>
<tr class="row-even"><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>
<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><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></p>
@@ -517,10 +520,10 @@ of Mod Organizer to be used by plugins.</p>
</dl>
</p></td>
</tr>
<tr class="row-odd"><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>
<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-even"><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>
<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><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></p>
@@ -528,7 +531,7 @@ of Mod Organizer to be used by plugins.</p>
</dl>
</p></td>
</tr>
<tr class="row-odd"><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>
<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><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
@@ -536,7 +539,7 @@ of Mod Organizer to be used by plugins.</p>
</dl>
</p></td>
</tr>
<tr class="row-even"><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>
<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><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
@@ -544,25 +547,25 @@ of Mod Organizer to be used by plugins.</p>
</dl>
</p></td>
</tr>
<tr class="row-odd"><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>
<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>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.resolvePath" title="mobase.IOrganizer.resolvePath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">resolvePath</span></code></a>(filename)</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.resolvePath" title="mobase.IOrganizer.resolvePath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">resolvePath</span></code></a>(filename)</p></td>
<td><p>Resolves a path relative to the virtual data directory to its absolute real path.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.setPersistent" title="mobase.IOrganizer.setPersistent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setPersistent</span></code></a>(plugin_name,Β key,Β value[,Β sync])</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.setPersistent" title="mobase.IOrganizer.setPersistent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setPersistent</span></code></a>(plugin_name,Β key,Β value[,Β sync])</p></td>
<td><p>Set the specified persistent value for a plugin.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.setPluginSetting" title="mobase.IOrganizer.setPluginSetting"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setPluginSetting</span></code></a>(plugin_name,Β key,Β value)</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.setPluginSetting" title="mobase.IOrganizer.setPluginSetting"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setPluginSetting</span></code></a>(plugin_name,Β key,Β value)</p></td>
<td><p>Set the specified setting for a plugin.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.startApplication" title="mobase.IOrganizer.startApplication"><code class="xref py py-obj docutils literal notranslate"><span class="pre">startApplication</span></code></a>(executable[,Β args,Β cwd,Β ...])</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.startApplication" title="mobase.IOrganizer.startApplication"><code class="xref py py-obj docutils literal notranslate"><span class="pre">startApplication</span></code></a>(executable[,Β args,Β cwd,Β ...])</p></td>
<td><p>Starts an application with virtual filesystem active.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.virtualFileTree" title="mobase.IOrganizer.virtualFileTree"><code class="xref py py-obj docutils literal notranslate"><span class="pre">virtualFileTree</span></code></a>()</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.virtualFileTree" title="mobase.IOrganizer.virtualFileTree"><code class="xref py py-obj docutils literal notranslate"><span class="pre">virtualFileTree</span></code></a>()</p></td>
<td><p>Retrieve a IFileTree object representing the virtual file tree.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IOrganizer.waitForApplication" title="mobase.IOrganizer.waitForApplication"><code class="xref py py-obj docutils literal notranslate"><span class="pre">waitForApplication</span></code></a>(handle[,Β refresh])</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IOrganizer.waitForApplication" title="mobase.IOrganizer.waitForApplication"><code class="xref py py-obj docutils literal notranslate"><span class="pre">waitForApplication</span></code></a>(handle[,Β refresh])</p></td>
<td><p>Wait for the application corresponding to the given handle to finish.</p></td>
</tr>
</tbody>
@@ -827,22 +830,8 @@ from the display name for disambiguation.</p>
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IOrganizer.onAboutToRun">
<span class="sig-name descname"><span class="pre">onAboutToRun</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callback</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IOrganizer.onAboutToRun" title="Link to this definition"></a></dt>
<dd><p>Install a new handler to be called when an application is about to run.</p>
<p>Multiple handlers can be installed. If any of the handler returns <cite>False</cite>, the application will
not run.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
</dd>
<dt class="field-even">Parameters<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>callback</strong> – The function to call when an application is about to run. The parameter is the absolute path
to the application to run. The function can return False to prevent the application from running.</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>True if the handler was installed properly (there are currently no reasons for this to fail).</p>
</dd>
</dl>
<span class="sig-name descname"><span class="pre">onAboutToRun</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwds</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IOrganizer.onAboutToRun" title="Link to this definition"></a></dt>
<dd><p>Helper for &#64;overload to raise when called.</p>
</dd></dl>
<dl class="py method">
@@ -858,9 +847,31 @@ to the application to run. The function can return False to prevent the applicat
path to the application, and the second parameter is the exit code of the application.</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>True if the handler was installed properly (there are currently no reasons for this to fail).</p>
<dd class="field-odd"><p>True if the handler was installed properly (there are currently no reasons for</p>
</dd>
</dl>
<p>this to fail).</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IOrganizer.onNextRefresh">
<span class="sig-name descname"><span class="pre">onNextRefresh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callback</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">immediate_if_possible</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IOrganizer.onNextRefresh" title="Link to this definition"></a></dt>
<dd><p>Install a new handler to be called on the next refresh or immediately.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
</dd>
<dt class="field-even">Parameters<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>callback</strong> – Function to call on the next refresh (or immediately).</p></li>
<li><p><strong>immediate_if_possible</strong> – If True, immediately run the callback if no refresh is currently running.</p></li>
</ul>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>True if the handler was installed properly (there are currently no reasons for</p>
</dd>
</dl>
<p>this to fail).</p>
</dd></dl>
<dl class="py method">
api/mobase.IPluginGame.html
+64 -43
View File
@@ -417,7 +417,15 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-odd"><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>
<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><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>]</p>
</dd>
</dl>
</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><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>]</p>
@@ -425,7 +433,7 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-even"><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>
<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><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>]</p>
@@ -433,13 +441,13 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-odd"><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>
<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>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.featureList" title="mobase.IPluginGame.featureList"><code class="xref py py-obj docutils literal notranslate"><span class="pre">featureList</span></code></a>()</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.featureList" title="mobase.IPluginGame.featureList"><code class="xref py py-obj docutils literal notranslate"><span class="pre">featureList</span></code></a>()</p></td>
<td><p>Retrieve the list of game features implemented for this plugin.</p></td>
</tr>
<tr class="row-odd"><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>
<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><code class="xref py py-class docutils literal notranslate"><span class="pre">QDir</span></code></p>
@@ -447,7 +455,7 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-even"><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>
<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><code class="xref py py-class docutils literal notranslate"><span class="pre">QIcon</span></code></p>
@@ -455,7 +463,7 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-odd"><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>
<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><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
@@ -463,7 +471,7 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-even"><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>
<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><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
@@ -471,7 +479,7 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-odd"><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>
<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><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
@@ -479,10 +487,10 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-even"><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>
<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-odd"><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>
<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><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
@@ -490,7 +498,7 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-even"><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>
<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><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
@@ -498,7 +506,7 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-odd"><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>
<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><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
@@ -506,7 +514,7 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-even"><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>
<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><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>]</p>
@@ -514,10 +522,10 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-odd"><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>
<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-even"><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>
<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><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
@@ -525,10 +533,10 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-odd"><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>
<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-even"><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>
<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><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></p>
@@ -536,16 +544,16 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-odd"><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>
<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>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.nexusGameID" title="mobase.IPluginGame.nexusGameID"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nexusGameID</span></code></a>()</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.nexusGameID" title="mobase.IPluginGame.nexusGameID"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nexusGameID</span></code></a>()</p></td>
<td><p>Retrieve the Nexus game ID for this game.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.nexusModOrganizerID" title="mobase.IPluginGame.nexusModOrganizerID"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nexusModOrganizerID</span></code></a>()</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.nexusModOrganizerID" title="mobase.IPluginGame.nexusModOrganizerID"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nexusModOrganizerID</span></code></a>()</p></td>
<td><p>Retrieve the Nexus mod ID of Mod Organizer for this game.</p></td>
</tr>
<tr class="row-even"><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>
<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><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>]</p>
@@ -553,10 +561,10 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-odd"><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>
<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-even"><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>
<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><code class="xref py py-class docutils literal notranslate"><span class="pre">QDir</span></code></p>
@@ -564,16 +572,16 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-odd"><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>
<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>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.setGamePath" title="mobase.IPluginGame.setGamePath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setGamePath</span></code></a>(path)</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.setGamePath" title="mobase.IPluginGame.setGamePath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setGamePath</span></code></a>(path)</p></td>
<td><p>Set the path to the managed game.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.setGameVariant" title="mobase.IPluginGame.setGameVariant"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setGameVariant</span></code></a>(variant)</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.setGameVariant" title="mobase.IPluginGame.setGameVariant"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setGameVariant</span></code></a>(variant)</p></td>
<td><p>Set the game variant.</p></td>
</tr>
<tr class="row-even"><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>
<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><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></p>
@@ -581,10 +589,10 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
</dl>
</p></td>
</tr>
<tr class="row-odd"><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>
<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>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginGame.validShortNames" title="mobase.IPluginGame.validShortNames"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validShortNames</span></code></a>()</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginGame.validShortNames" title="mobase.IPluginGame.validShortNames"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validShortNames</span></code></a>()</p></td>
<td><p>Retrieve the valid 'short' names for this game.</p></td>
</tr>
</tbody>
@@ -592,7 +600,7 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
<p class="rubric">Methods Documentation</p>
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IPluginGame.CCPlugins">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CCPlugins</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.CCPlugins" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">CCPlugins</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.CCPlugins" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><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>]</p>
@@ -605,7 +613,7 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IPluginGame.DLCPlugins">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DLCPlugins</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.DLCPlugins" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">DLCPlugins</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.DLCPlugins" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><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>]</p>
@@ -676,6 +684,19 @@ methods should work properly after the call to <cite>detectGame()</cite> (and be
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IPluginGame.enabledPlugins">
<span class="sig-name descname"><span class="pre">enabledPlugins</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.enabledPlugins" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><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>]</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A list of plugins enabled by the game but not in a strict load order.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IPluginGame.executableForcedLoads">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">executableForcedLoads</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.executableForcedLoads" title="Link to this definition"></a></dt>
@@ -691,7 +712,7 @@ methods should work properly after the call to <cite>detectGame()</cite> (and be
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IPluginGame.executables">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">executables</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.executables" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">executables</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.executables" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><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>]</p>
@@ -776,7 +797,7 @@ methods should work properly after the call to <cite>detectGame()</cite> (and be
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IPluginGame.gameNexusName">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">gameNexusName</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.gameNexusName" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">gameNexusName</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.gameNexusName" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
@@ -802,7 +823,7 @@ methods should work properly after the call to <cite>detectGame()</cite> (and be
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IPluginGame.gameVariants">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">gameVariants</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.gameVariants" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">gameVariants</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.gameVariants" title="Link to this definition"></a></dt>
<dd><p>Retrieve the list of variants for this game.</p>
<p>If there are multiple variants of a game (and the variants make a difference to the
plugin), like a regular one and a GOTY-edition, the plugin can return a list of them
@@ -859,7 +880,7 @@ and the user gets to chose which one he owns.</p>
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IPluginGame.iniFiles">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">iniFiles</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.iniFiles" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">iniFiles</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.iniFiles" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><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>]</p>
@@ -924,7 +945,7 @@ it so the implementations have to gracefully handle the case that the directory
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IPluginGame.loadOrderMechanism">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">loadOrderMechanism</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.loadOrderMechanism" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">loadOrderMechanism</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.loadOrderMechanism" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><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></p>
@@ -969,7 +990,7 @@ it so the implementations have to gracefully handle the case that the directory
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IPluginGame.nexusModOrganizerID">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">nexusModOrganizerID</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.nexusModOrganizerID" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">nexusModOrganizerID</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.nexusModOrganizerID" title="Link to this definition"></a></dt>
<dd><p>Retrieve the Nexus mod ID of Mod Organizer for this game.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
@@ -989,7 +1010,7 @@ it so the implementations have to gracefully handle the case that the directory
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IPluginGame.primaryPlugins">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">primaryPlugins</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.primaryPlugins" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">primaryPlugins</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.primaryPlugins" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><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>]</p>
@@ -1002,7 +1023,7 @@ it so the implementations have to gracefully handle the case that the directory
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IPluginGame.primarySources">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">primarySources</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.primarySources" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">primarySources</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.primarySources" title="Link to this definition"></a></dt>
<dd><p>Retrieve primary alternative β€˜short’ names for this game.</p>
<p>This is used to determine if a Nexus (or other) download source should be considered
as a primary source for the game so that it is not flagged as an alternative one.</p>
@@ -1031,7 +1052,7 @@ as a primary source for the game so that it is not flagged as an alternative one
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IPluginGame.secondaryDataDirectories">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">secondaryDataDirectories</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.secondaryDataDirectories" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">secondaryDataDirectories</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.secondaryDataDirectories" title="Link to this definition"></a></dt>
<dd><p>Retrieve the list of secondary data directories. Each directories should be
assigned a unique name that differs from β€œdata” which is the name of the main
data directory returned by dataDirectory().</p>
@@ -1080,7 +1101,7 @@ called on start with the user-selected game variant.</p>
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IPluginGame.sortMechanism">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sortMechanism</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.sortMechanism" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">sortMechanism</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.sortMechanism" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><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></p>
@@ -1093,7 +1114,7 @@ called on start with the user-selected game variant.</p>
<dl class="py method">
<dt class="sig sig-object py" id="mobase.IPluginGame.steamAPPId">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">steamAPPId</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.steamAPPId" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">steamAPPId</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.steamAPPId" title="Link to this definition"></a></dt>
<dd><p>Retrieve the Steam app ID for this game.</p>
<p>If the game is not available on Steam, this should return an empty string.</p>
<p>If a game is available in multiple versions, those might have different app ids. The plugin
genindex.html
+4
View File
@@ -598,6 +598,8 @@
<li><a href="api/mobase.ExecutableForcedLoadSetting.html#mobase.ExecutableForcedLoadSetting.enabled">enabled() (mobase.ExecutableForcedLoadSetting method)</a>
</li>
<li><a href="api/mobase.IPlugin.html#mobase.IPlugin.enabledByDefault">enabledByDefault() (mobase.IPlugin method)</a>
</li>
<li><a href="api/mobase.IPluginGame.html#mobase.IPluginGame.enabledPlugins">enabledPlugins() (mobase.IPluginGame method)</a>
</li>
<li><a href="api/mobase.ModState.html#mobase.ModState.ENDORSED">ENDORSED (mobase.ModState attribute)</a>
</li>
@@ -1154,6 +1156,8 @@
<li><a href="api/mobase.IModList.html#mobase.IModList.onModRemoved">onModRemoved() (mobase.IModList method)</a>
</li>
<li><a href="api/mobase.IModList.html#mobase.IModList.onModStateChanged">onModStateChanged() (mobase.IModList method)</a>
</li>
<li><a href="api/mobase.IOrganizer.html#mobase.IOrganizer.onNextRefresh">onNextRefresh() (mobase.IOrganizer method)</a>
</li>
<li><a href="api/mobase.IOrganizer.html#mobase.IOrganizer.onPluginDisabled">onPluginDisabled() (mobase.IOrganizer method)</a>
</li>
objects.inv
BIN
View File
Binary file not shown.
searchindex.js
+1 -1
View File
File diff suppressed because one or more lines are too long