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 @ 4f9e212b9379db74594505f730cb48584743a17e 🚀

Browse Source
This commit is contained in:
Holt59
2021-01-18 21:09:43 +00:00
parent 04e482fa54
commit 7252600f83
133 changed files with 4526 additions and 4292 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/mobase.IPluginInstallerCustom.html
+41 -25
View File
@@ -3,9 +3,9 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>IPluginInstallerCustom &mdash; MO2 Python Plugin API 2.3rc1 documentation</title>
@@ -19,10 +19,13 @@
<link rel="shortcut icon" href="../_static/mo2.ico"/>
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
@@ -54,7 +57,7 @@
<a href="../index.html" class="icon icon-home" alt="Documentation Home"> MO2 Python Plugin API
<a href="../index.html" class="icon icon-home"> MO2 Python Plugin API
@@ -93,6 +96,7 @@
<li class="toctree-l3"><a class="reference internal" href="../setup-tools.html#get-the-mobase-stubs">1. Get the <code class="docutils literal notranslate"><span class="pre">mobase</span></code> stubs</a></li>
<li class="toctree-l3"><a class="reference internal" href="../setup-tools.html#configure-visual-studio-code-for-mobase">2. Configure Visual Studio Code for <code class="docutils literal notranslate"><span class="pre">mobase</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../setup-tools.html#configure-mypy-to-find-the-mobase-stubs">3. Configure <code class="docutils literal notranslate"><span class="pre">mypy</span></code> to find the <code class="docutils literal notranslate"><span class="pre">mobase</span></code> stubs</a></li>
<li class="toctree-l3"><a class="reference internal" href="../setup-tools.html#optional-automatically-reload-plugins-during-development">4. [Optional] Automatically reload plugins during development</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../setup-tools.html#testing-the-setup">Testing the setup</a></li>
@@ -147,6 +151,7 @@
<li class="toctree-l2 current"><a class="reference internal" href="../mobase.html#classes">Classes</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="mobase.BSAInvalidation.html">BSAInvalidation</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.DataArchives.html">DataArchives</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.EndorsedState.html">EndorsedState</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ExecutableForcedLoadSetting.html">ExecutableForcedLoadSetting</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ExecutableInfo.html">ExecutableInfo</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.FileInfo.html">FileInfo</a></li>
@@ -171,6 +176,7 @@
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginList.html">IPluginList</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginModPage.html">IPluginModPage</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginPreview.html">IPluginPreview</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginRequirement.html">IPluginRequirement</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginTool.html">IPluginTool</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IProfile.html">IProfile</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ISaveGame.html">ISaveGame</a></li>
@@ -184,6 +190,7 @@
<li class="toctree-l3"><a class="reference internal" href="mobase.ModDataContent.html">ModDataContent</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ModRepositoryFileInfo.html">ModRepositoryFileInfo</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ModState.html">ModState</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.PluginRequirementFactory.html">PluginRequirementFactory</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.PluginSetting.html">PluginSetting</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.PluginState.html">PluginState</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ProfileSetting.html">ProfileSetting</a></li>
@@ -191,6 +198,7 @@
<li class="toctree-l3"><a class="reference internal" href="mobase.SaveGameInfo.html">SaveGameInfo</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ScriptExtender.html">ScriptExtender</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.SortMechanism.html">SortMechanism</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.TrackedState.html">TrackedState</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.UnmanagedMods.html">UnmanagedMods</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.VersionInfo.html">VersionInfo</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.VersionScheme.html">VersionScheme</a></li>
@@ -238,6 +246,8 @@
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
@@ -251,7 +261,7 @@
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/mobase.IPluginInstallerCustom.rst.txt" rel="nofollow"> View page source</a>
@@ -272,7 +282,7 @@
<em class="property">class </em><code class="sig-prename descclassname">mobase.</code><code class="sig-name descname">IPluginInstallerCustom</code><a class="headerlink" href="#mobase.IPluginInstallerCustom" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="mobase.IPluginInstaller.html#mobase.IPluginInstaller" title="mobase.IPluginInstaller"><code class="xref py py-class docutils literal notranslate"><span class="pre">mobase.IPluginInstaller</span></code></a></p>
<p>Custom installer for mods. Custom installers receive the archive name and have to go
from there. They have to be able to extract the archive themself.</p>
from there. They have to be able to extract the archive themselves.</p>
<p>Example of such installers are the external NCC installer or the OMOD installer.</p>
<p class="rubric">Methods Summary</p>
<table class="longtable docutils align-default">
@@ -284,8 +294,8 @@ from there. They have to be able to extract the archive themself.</p>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IPluginInstallerCustom.install" title="mobase.IPluginInstallerCustom.install"><code class="xref py py-obj docutils literal notranslate"><span class="pre">install</span></code></a>(mod_name, game_name, archive_name, …)</p></td>
<td><p>Install the given archive.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginInstallerCustom.isArchiveSupported" title="mobase.IPluginInstallerCustom.isArchiveSupported"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isArchiveSupported</span></code></a>(**kwds)</p></td>
<td><p>Helper for &#64;overload to raise when called.</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IPluginInstallerCustom.isArchiveSupported" title="mobase.IPluginInstallerCustom.isArchiveSupported"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isArchiveSupported</span></code></a>(archive_name)</p></td>
<td><p>Check if the given file is a supported archive for this installer.</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">
@@ -306,11 +316,14 @@ from there. They have to be able to extract the archive themself.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>mod_name</strong> – Name of the mod to install. As an input parameter this is the suggested name (e.g. from meta data) The installer may change this parameter to rename the mod).</p></li>
<li><p><strong>mod_name</strong> – Name of the mod to install. As an input parameter this is the suggested name
(e.g. from meta data) The installer may change this parameter to rename the mod).</p></li>
<li><p><strong>game_name</strong> – Name of the game for which the mod is installed.</p></li>
<li><p><strong>archive_name</strong> – Name of the archive to install.</p></li>
<li><p><strong>version</strong> – Version of the mod. May be empty if the version is not yet known. The plugin is responsible for setting the version on the created mod.</p></li>
<li><p><strong>nexus_id</strong> – ID of the mod or -1 if unknown. The plugin is responsible for setting the mod ID for the created mod.</p></li>
<li><p><strong>version</strong> – Version of the mod. May be empty if the version is not yet known. The plugin is responsible
for setting the version on the created mod.</p></li>
<li><p><strong>nexus_id</strong> – ID of the mod or -1 if unknown. The plugin is responsible for setting the mod ID for the
created mod.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
@@ -324,8 +337,19 @@ from there. They have to be able to extract the archive themself.</p>
<dl class="method">
<dt id="mobase.IPluginInstallerCustom.isArchiveSupported">
<code class="sig-name descname">isArchiveSupported</code><span class="sig-paren">(</span><em class="sig-param">**kwds</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginInstallerCustom.isArchiveSupported" title="Permalink to this definition">¶</a></dt>
<dd><p>Helper for &#64;overload to raise when called.</p>
<em class="property">abstract </em><code class="sig-name descname">isArchiveSupported</code><span class="sig-paren">(</span><em class="sig-param">archive_name</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginInstallerCustom.isArchiveSupported" title="Permalink to this definition">¶</a></dt>
<dd><p>Check if the given file is a supported archive for this installer.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>archive_name</strong> – Name of the archive.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if this installer can handle the archive, False otherwise.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
@@ -350,37 +374,29 @@ from there. They have to be able to extract the archive themself.</p>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="mobase.IPluginInstallerSimple.html" class="btn btn-neutral float-right" title="IPluginInstallerSimple" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="mobase.IPluginInstaller.html" class="btn btn-neutral float-left" title="IPluginInstaller" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="mobase.IPluginInstallerSimple.html" class="btn btn-neutral float-right" title="IPluginInstallerSimple" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="mobase.IPluginInstaller.html" class="btn btn-neutral float-left" title="IPluginInstaller" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, Holt59
&#169; Copyright 2020, Holt59.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>