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
Files
04e482fa54eb8966d5e37bd946741b59bcfa7bbf
python-plugins-doc/api/mobase.IModInterface.html
T

571 lines
29 KiB
HTML
Raw Normal View History

Deploying to master from @ 6e9912d1ef483ea6a0c58c4e5cea03720a47af61 πŸš€
2020-09-24 13:47:11 +00:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>IModInterface &mdash; MO2 Python Plugin API 2.3rc1 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
Deploying to master from @ c60d1ac92f42de9a9cffa86064c76f4d9060f017 πŸš€
2020-09-24 14:17:15 +00:00
<link rel="shortcut icon" href="../_static/mo2.ico"/>
Deploying to master from @ 6e9912d1ef483ea6a0c58c4e5cea03720a47af61 πŸš€
2020-09-24 13:47:11 +00:00
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="IModList" href="mobase.IModList.html" />
<link rel="prev" title="IInstallationManager" href="mobase.IInstallationManager.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home" alt="Documentation Home"> MO2 Python Plugin API
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../setup-tools.html">Setting up the environment</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../setup-tools.html#required-tools">Required tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="../setup-tools.html#preparation">Preparation</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../setup-tools.html#testing-the-setup">Testing the setup</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../plugin-types.html">Type of Plugins</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../plugin-types.html#installers">Installers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugin-types.html#previewers">Previewers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugin-types.html#mod-page">Mod Page</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugin-types.html#game">Game</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugin-types.html#tool">Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugin-types.html#proxies">Proxies</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugin-types.html#free-plugins"><em>Free Plugins</em></a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugin-types.html#extension-interfaces">Extension Interfaces</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugin-types.html#diagnose">Diagnose</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugin-types.html#file-mappings">File Mappings</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../writing-plugins.html">Writing Plugins</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../writing-plugins.html#getting-started">Getting started</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../writing-plugins.html#single-file-plugins">Single file plugins</a></li>
<li class="toctree-l3"><a class="reference internal" href="../writing-plugins.html#module-plugins">Module Plugins</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../writing-plugins.html#writing-the-plugin">Writing the plugin</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../writing-plugins.html#iplugin-interface"><code class="docutils literal notranslate"><span class="pre">IPlugin</span></code> interface</a></li>
</ul>
</li>
Deploying to master from @ 822dfc161e2a059d5d135e3e4043822f4ae71890 πŸš€
2020-10-07 18:49:09 +00:00
<li class="toctree-l2"><a class="reference internal" href="../writing-plugins.html#examples">Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../writing-plugins.html#tutorial-plugins">Tutorial Plugins</a></li>
<li class="toctree-l3"><a class="reference internal" href="../writing-plugins.html#official-plugins">Official Plugins</a></li>
<li class="toctree-l3"><a class="reference internal" href="../writing-plugins.html#unofficial-plugins">Unofficial Plugins</a></li>
</ul>
</li>
Deploying to master from @ 6e9912d1ef483ea6a0c58c4e5cea03720a47af61 πŸš€
2020-09-24 13:47:11 +00:00
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a><ul>
<li class="toctree-l2"><a class="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>
<li class="toctree-l2"><a class="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>
<li class="toctree-l2"><a class="reference internal" href="../faq.html#why-are-my-isinstance-x-qobject-and-isinstance-y-qwidget-not-working">3. Why are my <code class="docutils literal notranslate"><span class="pre">isinstance(x,</span> <span class="pre">QObject)</span></code> and <code class="docutils literal notranslate"><span class="pre">isinstance(y,</span> <span class="pre">QWidget)</span></code> not working?</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="../mobase.html"><code class="docutils literal notranslate"><span class="pre">mobase</span></code> API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../mobase.html#functions">Functions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mobase.getFileVersion.html">getFileVersion</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.getIconForExecutable.html">getIconForExecutable</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.getProductVersion.html">getProductVersion</a></li>
</ul>
</li>
<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.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>
<li class="toctree-l3"><a class="reference internal" href="mobase.FileTreeEntry.html">FileTreeEntry</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.GamePlugins.html">GamePlugins</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.GuessQuality.html">GuessQuality</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.GuessedString.html">GuessedString</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IDownloadManager.html">IDownloadManager</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IFileTree.html">IFileTree</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IInstallationManager.html">IInstallationManager</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">IModInterface</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IModList.html">IModList</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IModRepositoryBridge.html">IModRepositoryBridge</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IOrganizer.html">IOrganizer</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPlugin.html">IPlugin</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginDiagnose.html">IPluginDiagnose</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginFileMapper.html">IPluginFileMapper</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginGame.html">IPluginGame</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginInstaller.html">IPluginInstaller</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginInstallerCustom.html">IPluginInstallerCustom</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.IPluginInstallerSimple.html">IPluginInstallerSimple</a></li>
<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.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>
<li class="toctree-l3"><a class="reference internal" href="mobase.ISaveGameInfoWidget.html">ISaveGameInfoWidget</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.InstallResult.html">InstallResult</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.InterfaceNotImplemented.html">InterfaceNotImplemented</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.LoadOrderMechanism.html">LoadOrderMechanism</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.LocalSavegames.html">LocalSavegames</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.Mapping.html">Mapping</a></li>
<li class="toctree-l3"><a class="reference internal" href="mobase.ModDataChecker.html">ModDataChecker</a></li>
<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.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>
<li class="toctree-l3"><a class="reference internal" href="mobase.ReleaseType.html">ReleaseType</a></li>
<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.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>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">MO2 Python Plugin API</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../mobase.html"><code class="docutils literal notranslate"><span class="pre">mobase</span></code> API</a> &raquo;</li>
<li>IModInterface</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/mobase.IModInterface.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="imodinterface">
<h1>IModInterface<a class="headerlink" href="#imodinterface" title="Permalink to this headline">ΒΆ</a></h1>
<dl class="class">
<dt id="mobase.IModInterface">
<em class="property">class </em><code class="sig-prename descclassname">mobase.</code><code class="sig-name descname">IModInterface</code><a class="headerlink" href="#mobase.IModInterface" title="Permalink to this definition">ΒΆ</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p class="rubric">Methods Summary</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.absolutePath" title="mobase.IModInterface.absolutePath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">absolutePath</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">returns</dt>
<dd class="field-odd"><p>Absolute path to the mod to be used in file system operations.</p>
</dd>
</dl>
</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.addCategory" title="mobase.IModInterface.addCategory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">addCategory</span></code></a>(name)</p></td>
<td><p>Assign a category to the mod.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.addNexusCategory" title="mobase.IModInterface.addNexusCategory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">addNexusCategory</span></code></a>(category_id)</p></td>
<td><p>Set the category id from a nexus category id.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.categories" title="mobase.IModInterface.categories"><code class="xref py py-obj docutils literal notranslate"><span class="pre">categories</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">returns</dt>
<dd class="field-odd"><p>The list of categories assigned to this mod.</p>
</dd>
</dl>
</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.name" title="mobase.IModInterface.name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">name</span></code></a>()</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">returns</dt>
<dd class="field-odd"><p>The name of this mod.</p>
</dd>
</dl>
</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.remove" title="mobase.IModInterface.remove"><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove</span></code></a>()</p></td>
<td><p>Delete the mod from the disc.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.removeCategory" title="mobase.IModInterface.removeCategory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">removeCategory</span></code></a>(name)</p></td>
<td><p>Unassign a category from this mod.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.setGameName" title="mobase.IModInterface.setGameName"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setGameName</span></code></a>(name)</p></td>
<td><p>Set the source game of this mod.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.setIsEndorsed" title="mobase.IModInterface.setIsEndorsed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setIsEndorsed</span></code></a>(endorsed)</p></td>
<td><p>Set endorsement state of the mod.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.setName" title="mobase.IModInterface.setName"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setName</span></code></a>(name)</p></td>
<td><p>Set the name of this mod.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.setNewestVersion" title="mobase.IModInterface.setNewestVersion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setNewestVersion</span></code></a>(version)</p></td>
<td><p>Set the latest known version of this mod.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.setNexusID" title="mobase.IModInterface.setNexusID"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setNexusID</span></code></a>(nexus_id)</p></td>
<td><p>Set the Nexus ID of this mod.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.setVersion" title="mobase.IModInterface.setVersion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setVersion</span></code></a>(version)</p></td>
<td><p>Set the version of this mod.</p></td>
</tr>
</tbody>
</table>
<p class="rubric">Methods Documentation</p>
<dl class="method">
<dt id="mobase.IModInterface.absolutePath">
<code class="sig-name descname">absolutePath</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.absolutePath" title="Permalink to this definition">ΒΆ</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Absolute path to the mod to be used in file system operations.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mobase.IModInterface.addCategory">
<code class="sig-name descname">addCategory</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.addCategory" title="Permalink 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</dt>
<dd class="field-odd"><p><strong>name</strong> – Name of the new category to assign.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mobase.IModInterface.addNexusCategory">
<code class="sig-name descname">addNexusCategory</code><span class="sig-paren">(</span><em class="sig-param">category_id</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.addNexusCategory" title="Permalink to this definition">ΒΆ</a></dt>
<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</dt>
<dd class="field-odd"><p><strong>category_id</strong> – The Nexus category ID.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mobase.IModInterface.categories">
<code class="sig-name descname">categories</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.categories" title="Permalink to this definition">ΒΆ</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The list of categories assigned to this mod.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mobase.IModInterface.name">
<code class="sig-name descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.name" title="Permalink to this definition">ΒΆ</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The name of this mod.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mobase.IModInterface.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.remove" title="Permalink to this definition">ΒΆ</a></dt>
<dd><p>Delete the mod from the disc.</p>
<p>This does not update the global ModInfo structure or indices.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>True if the mod was deleted, False otherwise.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mobase.IModInterface.removeCategory">
<code class="sig-name descname">removeCategory</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.removeCategory" title="Permalink to this definition">ΒΆ</a></dt>
<dd><p>Unassign a category from this mod.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> – Name of the category to remove.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if the category was removed, False otherwise (e.g. if no such category</p>
</dd>
</dl>
<p>was assigned).</p>
<dl class="field-list simple">
<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">
<dt id="mobase.IModInterface.setGameName">
<code class="sig-name descname">setGameName</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.setGameName" title="Permalink 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</dt>
<dd class="field-odd"><p><strong>name</strong> – The new source game short name of this mod.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mobase.IModInterface.setIsEndorsed">
<code class="sig-name descname">setIsEndorsed</code><span class="sig-paren">(</span><em class="sig-param">endorsed</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.setIsEndorsed" title="Permalink to this definition">ΒΆ</a></dt>
<dd><p>Set endorsement state of the mod.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>endorsed</strong> – New endorsement state of this mod.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mobase.IModInterface.setName">
<code class="sig-name descname">setName</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.setName" title="Permalink to this definition">ΒΆ</a></dt>
<dd><p>Set the name of this mod.</p>
<p>This will also update the name of the directory that contains this mod</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> – New name for this mod.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if the name was changed, False if an error occured (e.g. if the name is not a valid</p>
</dd>
</dl>
<p>directory name).</p>
<dl class="field-list simple">
<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">
<dt id="mobase.IModInterface.setNewestVersion">
<code class="sig-name descname">setNewestVersion</code><span class="sig-paren">(</span><em class="sig-param">version</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.setNewestVersion" title="Permalink 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</dt>
<dd class="field-odd"><p><strong>version</strong> – The latest known version of this mod.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mobase.IModInterface.setNexusID">
<code class="sig-name descname">setNexusID</code><span class="sig-paren">(</span><em class="sig-param">nexus_id</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.setNexusID" title="Permalink 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</dt>
<dd class="field-odd"><p><strong>nexus_id</strong> – Thew new Nexus ID of this mod.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mobase.IModInterface.setVersion">
<code class="sig-name descname">setVersion</code><span class="sig-paren">(</span><em class="sig-param">version</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.setVersion" title="Permalink to this definition">ΒΆ</a></dt>
<dd><p>Set the version of this mod.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>version</strong> – The new version of this mod.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="mobase.IModList.html" class="btn btn-neutral float-right" title="IModList" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="mobase.IInstallationManager.html" class="btn btn-neutral float-left" title="IInstallationManager" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, Holt59
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Reference in New Issue Copy Permalink