This commit is contained in:
Holt59
2023-09-23 10:24:28 +00:00
parent b4d0347d4e
commit 2d262f650f
34 changed files with 244 additions and 88 deletions
+40 -16
View File
@@ -601,8 +601,11 @@
<span class="sig-name descname"><span class="pre">addCategory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.addCategory" title="Link to this definition"></a></dt>
<dd><p>Assign a category to the mod. If the named category does not exist it is created.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>name</strong> – Name of the new category to assign.</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
<dt class="field-even">Parameters<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>name</strong> – Name of the new category to assign.</p>
</dd>
</dl>
</dd></dl>
@@ -613,8 +616,11 @@
<dd><p>Set the category id from a nexus category id. Conversion to MO ID happens internally.</p>
<p>If a mapping is not possible, the category is set to the default value.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>category_id</strong> – The Nexus category ID.</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
<dt class="field-even">Parameters<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>category_id</strong> – The Nexus category ID.</p>
</dd>
</dl>
</dd></dl>
@@ -958,8 +964,11 @@ unless you have a really good reason to access settings of another plugin.</p>
<span class="sig-name descname"><span class="pre">setGameName</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.setGameName" title="Link to this definition"></a></dt>
<dd><p>Set the source game of this mod.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>name</strong> – The new source game short name of this mod.</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
<dt class="field-even">Parameters<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>name</strong> – The new source game short name of this mod.</p>
</dd>
</dl>
</dd></dl>
@@ -969,8 +978,11 @@ unless you have a really good reason to access settings of another plugin.</p>
<span class="sig-name descname"><span class="pre">setIsEndorsed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endorsed</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.setIsEndorsed" title="Link to this definition"></a></dt>
<dd><p>Set endorsement state of the mod.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>endorsed</strong> – New endorsement state of this mod.</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
<dt class="field-even">Parameters<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>endorsed</strong> – New endorsement state of this mod.</p>
</dd>
</dl>
</dd></dl>
@@ -980,8 +992,11 @@ unless you have a really good reason to access settings of another plugin.</p>
<span class="sig-name descname"><span class="pre">setNewestVersion</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.setNewestVersion" title="Link to this definition"></a></dt>
<dd><p>Set the latest known version of this mod.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>version</strong> – The latest known version of this mod.</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
<dt class="field-even">Parameters<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>version</strong> – The latest known version of this mod.</p>
</dd>
</dl>
</dd></dl>
@@ -991,8 +1006,11 @@ unless you have a really good reason to access settings of another plugin.</p>
<span class="sig-name descname"><span class="pre">setNexusID</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nexus_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.setNexusID" title="Link to this definition"></a></dt>
<dd><p>Set the Nexus ID of this mod.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>nexus_id</strong> – Thew new Nexus ID of this mod.</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
<dt class="field-even">Parameters<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>nexus_id</strong> – Thew new Nexus ID of this mod.</p>
</dd>
</dl>
</dd></dl>
@@ -1024,8 +1042,11 @@ unless you have a really good reason to access settings of another plugin.</p></
<span class="sig-name descname"><span class="pre">setUrl</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.setUrl" title="Link to this definition"></a></dt>
<dd><p>Set the URL of this mod.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>url</strong> – The URL of this mod.</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
<dt class="field-even">Parameters<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>url</strong> – The URL of this mod.</p>
</dd>
</dl>
</dd></dl>
@@ -1035,8 +1056,11 @@ unless you have a really good reason to access settings of another plugin.</p></
<span class="sig-name descname"><span class="pre">setVersion</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.setVersion" title="Link to this definition"></a></dt>
<dd><p>Set the version of this mod.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>version</strong> – The new version of this mod.</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
<dt class="field-even">Parameters<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>version</strong> – The new version of this mod.</p>
</dd>
</dl>
</dd></dl>