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
+24 -4
View File
@@ -370,10 +370,20 @@
<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></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-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</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></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-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</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">
@@ -389,12 +399,22 @@
<dl class="py method">
<dt class="sig sig-object py" id="mobase.BSAInvalidation.activate">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">activate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.BSAInvalidation.activate" title="Link to this definition"></a></dt>
<dd></dd></dl>
<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-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mobase.BSAInvalidation.deactivate">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deactivate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.BSAInvalidation.deactivate" title="Link to this definition"></a></dt>
<dd></dd></dl>
<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-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mobase.BSAInvalidation.isInvalidationBSA">
+10 -4
View File
@@ -389,8 +389,11 @@
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">addArchive</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">index</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.DataArchives.addArchive" title="Link to this definition"></a></dt>
<dd><p>Add an archive to the archive list.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<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"><ul class="simple">
<li><p><strong>profile</strong> – Profile to add the archive to.</p></li>
<li><p><strong>index</strong> – Index to insert before. Use 0 for the beginning of the list or INT_MAX for
the end of the list).</p></li>
@@ -422,8 +425,11 @@ the end of the list).</p></li>
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">removeArchive</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.DataArchives.removeArchive" title="Link to this definition"></a></dt>
<dd><p>Remove the given archive from the given profile.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<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"><ul class="simple">
<li><p><strong>profile</strong> – Profile to remove the archive from.</p></li>
<li><p><strong>name</strong> – Name of the archive to remove.</p></li>
</ul>
+24 -4
View File
@@ -394,10 +394,20 @@
</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></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-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</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></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-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</p></td>
</tr>
</tbody>
</table>
@@ -441,12 +451,22 @@
<dl class="py method">
<dt class="sig sig-object py" id="mobase.GamePlugins.readPluginLists">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">readPluginLists</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plugin_list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.GamePlugins.readPluginLists" title="Link to this definition"></a></dt>
<dd></dd></dl>
<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-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mobase.GamePlugins.writePluginLists">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">writePluginLists</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plugin_list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.GamePlugins.writePluginLists" title="Link to this definition"></a></dt>
<dd></dd></dl>
<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-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
+5 -2
View File
@@ -408,8 +408,11 @@ class also allows a filter to be set. If a β€œguess” doesn’t pass the filter
<p>The filter is applied on every <cite>update()</cite> and can reject the new value
altogether or modify it (by returning a new value).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>filter</strong> – The new filter.</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>filter</strong> – The new filter.</p>
</dd>
</dl>
</dd></dl>
+6 -3
View File
@@ -638,7 +638,7 @@ given path is empty (<cite>β€œβ€</cite>), the entry is copied directly under th
type, <cite>None</cite> is returned.</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-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#mobase.IFileTree" title="mobase.IFileTree"><code class="xref py py-class docutils literal notranslate"><span class="pre">IFileTree</span></code></a>, <a class="reference internal" href="mobase.FileTreeEntry.html#mobase.FileTreeEntry" title="mobase.FileTreeEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileTreeEntry</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]</p>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">UnionType</span></code>[<a class="reference internal" href="#mobase.IFileTree" title="mobase.IFileTree"><code class="xref py py-class docutils literal notranslate"><span class="pre">IFileTree</span></code></a>, <a class="reference internal" href="mobase.FileTreeEntry.html#mobase.FileTreeEntry" title="mobase.FileTreeEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileTreeEntry</span></code></a>, <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"><ul class="simple">
@@ -836,8 +836,11 @@ directly from this tree will be removed. This method invalidates iterators.</p>
(with a trailing separator, not including the entry name), and the actual entry. The method returns
a <cite>WalkReturn</cite> object to indicates what to do.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<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"><ul class="simple">
<li><p><strong>callback</strong> – Method to call for each entry in the tree.</p></li>
<li><p><strong>sep</strong> – Type of separator to use to construct the path.</p></li>
</ul>
+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>
+29 -14
View File
@@ -409,8 +409,8 @@
</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">param game_name<span class="colon">:</span></dt>
<dd class="field-odd"><p>Name of the game containing the mod.</p>
<dt class="field-odd">rtype<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>
</dl>
</p></td>
@@ -420,8 +420,8 @@
</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">param game_name<span class="colon">:</span></dt>
<dd class="field-odd"><p>Name of the game containing the mod.</p>
<dt class="field-odd">rtype<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>
</dl>
</p></td>
@@ -480,8 +480,11 @@
<span class="sig-name descname"><span class="pre">requestDescription</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">game_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mod_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModRepositoryBridge.requestDescription" title="Link to this definition"></a></dt>
<dd><p>Request description of a mod.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<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"><ul class="simple">
<li><p><strong>game_name</strong> – Name of the game containing the mod.</p></li>
<li><p><strong>mod_id</strong> – Nexus ID of the mod.</p></li>
<li><p><strong>user_data</strong> – User data to be returned with the result.</p></li>
@@ -495,8 +498,11 @@
<span class="sig-name descname"><span class="pre">requestDownloadURL</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">game_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mod_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModRepositoryBridge.requestDownloadURL" title="Link to this definition"></a></dt>
<dd><p>Request download URL for mod file.0</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<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"><ul class="simple">
<li><p><strong>game_name</strong> – Name of the game containing the mod.</p></li>
<li><p><strong>mod_id</strong> – Nexus ID of the mod.</p></li>
<li><p><strong>file_id</strong> – ID of the file for which a URL should be returned.</p></li>
@@ -510,8 +516,11 @@
<dt class="sig sig-object py" id="mobase.IModRepositoryBridge.requestFileInfo">
<span class="sig-name descname"><span class="pre">requestFileInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">game_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mod_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModRepositoryBridge.requestFileInfo" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<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"><ul class="simple">
<li><p><strong>game_name</strong> – Name of the game containing the mod.</p></li>
<li><p><strong>mod_id</strong> – Nexus ID of the mod.</p></li>
<li><p><strong>file_id</strong> – ID of the file for which information is requested.</p></li>
@@ -526,8 +535,11 @@
<span class="sig-name descname"><span class="pre">requestFiles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">game_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mod_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModRepositoryBridge.requestFiles" title="Link to this definition"></a></dt>
<dd><p>Request the list of files belonging to a mod.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<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"><ul class="simple">
<li><p><strong>game_name</strong> – Name of the game containing the mod.</p></li>
<li><p><strong>mod_id</strong> – Nexus ID of the mod.</p></li>
<li><p><strong>user_data</strong> – User data to be returned with the result.</p></li>
@@ -540,8 +552,11 @@
<dt class="sig sig-object py" id="mobase.IModRepositoryBridge.requestToggleEndorsement">
<span class="sig-name descname"><span class="pre">requestToggleEndorsement</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">game_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mod_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mod_version</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endorse</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModRepositoryBridge.requestToggleEndorsement" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<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"><ul class="simple">
<li><p><strong>game_name</strong> – Name of the game containing the mod.</p></li>
<li><p><strong>mod_id</strong> – Nexus ID of the mod.</p></li>
<li><p><strong>mod_version</strong> – Version of the mod.</p></li>
+20 -8
View File
@@ -790,8 +790,11 @@ from the display name for disambiguation.</p>
<span class="sig-name descname"><span class="pre">modDataChanged</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mod</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IOrganizer.modDataChanged" title="Link to this definition"></a></dt>
<dd><p>Notify the organizer that the given mod has changed.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mod</strong> – The mod that has changed.</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>mod</strong> – The mod that has changed.</p>
</dd>
</dl>
</dd></dl>
@@ -1120,8 +1123,11 @@ list, data tab and other smaller things like problems button (same as pressing F
<p>The main part of the refresh of the mods file structure, mod list and plugin list is done
asynchronously, so you should not expect them to be up-to-date when this function returns.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>save_changes</strong> – If True, the relevant profile information is saved first (enabled mods and order of mods).</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>save_changes</strong> – If True, the relevant profile information is saved first (enabled mods and order of mods).</p>
</dd>
</dl>
</dd></dl>
@@ -1149,8 +1155,11 @@ asynchronously, so you should not expect them to be up-to-date when this functio
<dd><p>Set the specified persistent value for a plugin.</p>
<p>This does not update the in-memory value for this setting, see <cite>setPluginSetting()</cite> for this.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<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"><ul class="simple">
<li><p><strong>plugin_name</strong> – Name of the plugin for which to change a value. This should always be <cite>IPlugin.name()</cite> unless you have a
really good reason to access data of another mod AND if you can verify that plugin is actually installed.</p></li>
<li><p><strong>key</strong> – Identifier of the setting.</p></li>
@@ -1167,8 +1176,11 @@ really good reason to access data of another mod AND if you can verify that plug
<dd><p>Set the specified setting for a plugin.</p>
<p>This automatically notify handlers register with <cite>onPluginSettingChanged</cite>, so you do not have to do it yourself.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<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"><ul class="simple">
<li><p><strong>plugin_name</strong> – Name of the plugin for which to change a value. This should always be <cite>IPlugin.name()</cite> unless you have a
really good reason to access data of another mod AND if you can verify that plugin is actually installed.</p></li>
<li><p><strong>key</strong> – Identifier of the setting.</p></li>
+7 -4
View File
@@ -473,11 +473,14 @@ such as <cite>shortDescription()</cite> or <cite>hasGuidedFix()</cite>.</p>
<p>This method should throw <cite>ValueError</cite> if there is no guided fix for the corresponding
problem.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>key</strong> – ID of the problem.</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">Raises<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<dt class="field-even">Parameters<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>key</strong> – ID of the problem.</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>IndexError</strong> – If the key is not valid.</p></li>
<li><p><strong>ValueError</strong> – If there is no guided fix for this problem.</p></li>
</ul>
+18 -8
View File
@@ -647,7 +647,8 @@ plugin: <a class="reference external" href="https://github.com/ModOrganizer2/mod
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">detectGame</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginGame.detectGame" title="Link to this definition"></a></dt>
<dd><p>Detect the game.</p>
<p>This method is the first called for game plugins (before <cite>init()</cite>). The following
methods should work properly after the call to <cite>detectGame()</cite> (and before <cite>init()</cite>):</p>
methods should work properly after the call to <cite>detectGame()</cite> (and before <cite>init()</cite>):
:rtype: <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
<blockquote>
<div><ul class="simple">
<li><p>gameName()</p></li>
@@ -726,7 +727,7 @@ methods should work properly after the call to <cite>detectGame()</cite> (and be
<p>Python plugin should not implement this method but <cite>_featureList()</cite>.</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">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code>(<code class="docutils literal notranslate"><span class="pre">GameFeatureType</span></code>)], <code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code>(<code class="docutils literal notranslate"><span class="pre">GameFeatureType</span></code>)]</p>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code>(<code class="docutils literal notranslate"><span class="pre">GameFeatureType</span></code>)], <code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code>(<code class="docutils literal notranslate"><span class="pre">GameFeatureType</span></code>)]</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A mapping from feature type to actual game features.</p>
@@ -879,8 +880,11 @@ with this future functionality in mind.</p>
<p>This function will be used to initially create a profile, potentially to repair it or upgrade/downgrade
it so the implementations have to gracefully handle the case that the directory already contains files.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<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"><ul class="simple">
<li><p><strong>directory</strong> – The directory where the profile is to be initialized.</p></li>
<li><p><strong>settings</strong> – The parameters for how the profile should be initialized.</p></li>
</ul>
@@ -1049,8 +1053,11 @@ data directory returned by dataDirectory().</p>
to specify the installation location. This is not called if the game has been auto-detected,
so <cite>isInstalled()</cite> should call this.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>path</strong> – Path to the game installation.</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>path</strong> – Path to the game installation.</p>
</dd>
</dl>
</dd></dl>
@@ -1062,8 +1069,11 @@ so <cite>isInstalled()</cite> should call this.</p>
<p>If there are multiple variants of game (as returned by <cite>gameVariants()</cite>), this will be
called on start with the user-selected game variant.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>variant</strong> – The game variant selected by the user.</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>variant</strong> – The game variant selected by the user.</p>
</dd>
</dl>
</dd></dl>
+20 -8
View File
@@ -439,8 +439,11 @@ used by the external NCC installer and the OMOD installer.</p></li>
<dd><p>Method calls at the end of the installation process. This method is only called once
per installation process, even for recursive installations (e.g. with the bundle installer).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<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"><ul class="simple">
<li><p><strong>result</strong> – The result of the installation.</p></li>
<li><p><strong>new_mod</strong> – If the installation succeeded (result is RESULT_SUCCESS), contains the newly
installed mod, otherwise it contains a null pointer.</p></li>
@@ -461,8 +464,11 @@ it corresponds to a mod MO2 thinks corresponds to the archive (e.g. based on mat
or name).</p>
<p>The default implementation does nothing.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<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"><ul class="simple">
<li><p><strong>archive</strong> – Path to the archive that is going to be installed.</p></li>
<li><p><strong>reinstallation</strong> – True if this is a reinstallation, False otherwise.</p></li>
<li><p><strong>current_mod</strong> – A currently installed mod corresponding to the archive being installed, or None
@@ -494,8 +500,11 @@ if there is no such mod.</p></li>
<p>Python plugins usually do not need to re-implement this and can directly access the installation
manager using <cite>_manager()</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>manager</strong> – The installation manager.</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>manager</strong> – The installation manager.</p>
</dd>
</dl>
</dd></dl>
@@ -507,8 +516,11 @@ manager using <cite>_manager()</cite>.</p>
<p>Python plugins usually do not need to re-implement this and can directly access the parent
widget using <cite>_parentWidget()</cite> once the UI has been initialized.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>parent</strong> – The parent widget.</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>parent</strong> – The parent widget.</p>
</dd>
</dl>
</dd></dl>
+10 -4
View File
@@ -648,8 +648,11 @@ plugin states for the plugin whose states have changed.</p>
<p>Plugins not included in the list will be placed at highest priority in the order they
were before.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>loadorder</strong> – The new load order, specified by the list of plugin names, sorted.</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>loadorder</strong> – The new load order, specified by the list of plugin names, sorted.</p>
</dd>
</dl>
</dd></dl>
@@ -681,8 +684,11 @@ at the specified priority (e.g. when trying to move a non-master plugin before a
<span class="sig-name descname"><span class="pre">setState</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginList.setState" title="Link to this definition"></a></dt>
<dd><p>Set the state of a plugin.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<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"><ul class="simple">
<li><p><strong>name</strong> – Filename of the plugin (without path but with file extension).</p></li>
<li><p><strong>state</strong> – New state of the plugin (<cite>INACTIVE</cite> or <cite>ACTIVE</cite>).</p></li>
</ul>
+5 -2
View File
@@ -472,8 +472,11 @@
<p>Python plugins usually do not need to re-implement this and can directly access the parent
widget using <cite>_parentWidget()</cite> once the UI has been initialized.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>parent</strong> – The parent widget.</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>parent</strong> – The parent widget.</p>
</dd>
</dl>
</dd></dl>
+10 -2
View File
@@ -412,6 +412,11 @@ application itself.</p>
<dt class="sig sig-object py" id="mobase.IPluginTool.display">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">display</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IPluginTool.display" title="Link to this definition"></a></dt>
<dd><p>Called when the user starts the tool.</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-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
@@ -447,8 +452,11 @@ application itself.</p>
<p>Python plugins usually do not need to re-implement this and can directly access the parent
widget using <cite>_parentWidget()</cite> once the UI has been initialized.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>parent</strong> – The parent widget.</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>parent</strong> – The parent widget.</p>
</dd>
</dl>
</dd></dl>
+5 -2
View File
@@ -381,8 +381,11 @@
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setSave</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">save</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.ISaveGameInfoWidget.setSave" title="Link to this definition"></a></dt>
<dd><p>Set the save file to display in this widget.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>save</strong> – The save to display in the widget</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>save</strong> – The save to display in the widget</p>
</dd>
</dl>
</dd></dl>
+10 -2
View File
@@ -434,6 +434,11 @@
<dt class="sig sig-object py" id="mobase.VersionInfo.clear">
<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.VersionInfo.clear" title="Link to this definition"></a></dt>
<dd><p>Resets this VersionInfo to an invalid version.</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-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
@@ -472,8 +477,11 @@ and [4,inf) for major/minor/subminor/subsubminor. This only versions with a regu
<span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scheme=VersionScheme.None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_manual=False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.VersionInfo.parse" title="Link to this definition"></a></dt>
<dd><p>Update this VersionInfo by parsing the given string using the given scheme.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<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"><ul class="simple">
<li><p><strong>value</strong> – String to parse.</p></li>
<li><p><strong>scheme</strong> – Scheme to use to parse the string.</p></li>
<li><p><strong>is_manual</strong> – True if the given string should be treated as user input.</p></li>