<liclass="toctree-l3"><aclass="reference internal"href="../setup-tools.html#get-the-mobase-stubs">1. Get the <codeclass="docutils literal notranslate"><spanclass="pre">mobase</span></code> stubs</a></li>
<liclass="toctree-l3"><aclass="reference internal"href="../setup-tools.html#configure-visual-studio-code-for-mobase">2. Configure Visual Studio Code for <codeclass="docutils literal notranslate"><spanclass="pre">mobase</span></code></a></li>
<liclass="toctree-l3"><aclass="reference internal"href="../setup-tools.html#configure-mypy-to-find-the-mobase-stubs">3. Configure <codeclass="docutils literal notranslate"><spanclass="pre">mypy</span></code> to find the <codeclass="docutils literal notranslate"><spanclass="pre">mobase</span></code> stubs</a></li>
</ul>
</li>
<liclass="toctree-l2"><aclass="reference internal"href="../setup-tools.html#testing-the-setup">Testing the setup</a></li>
</ul>
</li>
<liclass="toctree-l1"><aclass="reference internal"href="../plugin-types.html">Type of Plugins</a><ul>
<liclass="toctree-l2"><aclass="reference internal"href="../faq.html#why-is-mo2-throwing-an-exception-when-i-try-to-create-a-type-inheriting-one-of-mo2-class">1. Why is MO2 throwing an exception when I try to create a type inheriting one of MO2 class?</a></li>
<liclass="toctree-l2"><aclass="reference internal"href="../faq.html#how-can-i-be-sure-to-implement-all-the-required-methods-when-creating-a-plugin">2. How can I be sure to implement all the required methods when creating a plugin?</a></li>
<liclass="toctree-l2"><aclass="reference internal"href="../faq.html#why-are-my-isinstance-x-qobject-and-isinstance-y-qwidget-not-working">3. Why are my <codeclass="docutils literal notranslate"><spanclass="pre">isinstance(x,</span><spanclass="pre">QObject)</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">isinstance(y,</span><spanclass="pre">QWidget)</span></code> not working?</a></li>
<h1>IInstallationManager<aclass="headerlink"href="#iinstallationmanager"title="Permalink to this headline">ΒΆ</a></h1>
<dlclass="class">
<dtid="mobase.IInstallationManager">
<emclass="property">class </em><codeclass="sig-prename descclassname">mobase.</code><codeclass="sig-name descname">IInstallationManager</code><aclass="headerlink"href="#mobase.IInstallationManager"title="Permalink to this definition">ΒΆ</a></dt>
<td><p>Set the url associated with the mod being installed.</p></td>
</tr>
</tbody>
</table>
<pclass="rubric">Methods Documentation</p>
<dlclass="method">
<dtid="mobase.IInstallationManager.createFile">
<codeclass="sig-name descname">createFile</code><spanclass="sig-paren">(</span><emclass="sig-param">entry</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IInstallationManager.createFile"title="Permalink to this definition">ΒΆ</a></dt>
<dd><p>Create a new file on the disk corresponding to the given entry.</p>
<p>This method can be used by installer that needs to create files that are not in the original
archive. At the end of the installation, if there are entries in the final tree that were used
to create files, the corresponding files will be moved to the mod folder.</p>
<p>Temporary files corresponding to created files are automatically cleaned up at the end of
the installation.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>entry</strong>β The entry for which a temporary file should be created.</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>The path to the created file, or an empty string if the file could not be created.</p>
<codeclass="sig-name descname">extractFile</code><spanclass="sig-paren">(</span><emclass="sig-param">entry</em>, <emclass="sig-param">silent=False</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IInstallationManager.extractFile"title="Permalink to this definition">ΒΆ</a></dt>
<dd><p>Extract the specified file from the currently opened archive to a temporary
location.</p>
<p>This method cannot be used to extract directory.</p>
<p>The call will fail with an exception if no archive is open (plugins deriving from
IPluginInstallerSimple can rely on that, custom installers should not). The temporary
file is automatically cleaned up after the installation. This call can be very slow
if the archive is large and βsolidβ.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>entry</strong>β Entry corresponding to the file to extract.</p></li>
<li><p><strong>silent</strong>β If true, the dialog showing extraction progress will not be shown.</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>The absolute path to the temporary file, or an empty string if the file was not extracted.</p>
<codeclass="sig-name descname">extractFiles</code><spanclass="sig-paren">(</span><emclass="sig-param">entries</em>, <emclass="sig-param">silent=False</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IInstallationManager.extractFiles"title="Permalink to this definition">ΒΆ</a></dt>
<dd><p>Extract the specified files from the currently opened archive to a temporary
location.</p>
<p>This method cannot be used to extract directories.</p>
<p>The call will fail with an exception if no archive is open (plugins deriving from
IPluginInstallerSimple can rely on that, custom installers should not). The temporary
files are automatically cleaned up after the installation. This call can be very slow
if the archive is large and βsolidβ.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>entries</strong>β Entries corresponding to the files to extract.</p></li>
<li><p><strong>silent</strong>β If true, the dialog showing extraction progress will not be shown.</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>A list containing absolute paths to the temporary files.</p>
<codeclass="sig-name descname">getSupportedExtensions</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IInstallationManager.getSupportedExtensions"title="Permalink to this definition">ΒΆ</a></dt>
<dd><dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p>The extensions of archives supported by this installation manager.</p>
<codeclass="sig-name descname">installArchive</code><spanclass="sig-paren">(</span><emclass="sig-param">mod_name</em>, <emclass="sig-param">archive</em>, <emclass="sig-param">mod_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IInstallationManager.installArchive"title="Permalink to this definition">ΒΆ</a></dt>
<dd><p>Install the given archive.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>mod_name</strong>β Suggested name of the mod.</p></li>
<li><p><strong>archive</strong>β Path to the archive to install.</p></li>
<li><p><strong>mod_id</strong>β ID of the mod, if available.</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>The result of the installation.</p>
<codeclass="sig-name descname">setURL</code><spanclass="sig-paren">(</span><emclass="sig-param">url</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.IInstallationManager.setURL"title="Permalink to this definition">ΒΆ</a></dt>
<dd><p>Set the url associated with the mod being installed.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>url</strong>β Url to set.</p>
