mirror of
https://github.com/ModOrganizer2/python-plugins-doc.git
synced 2026-07-27 14:07:44 -07:00
1087 lines
61 KiB
HTML
1087 lines
61 KiB
HTML
|
||
|
||
<!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 — 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" />
|
||
|
||
|
||
|
||
<link rel="shortcut icon" href="../_static/mo2.ico"/>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<!--[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"> 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>
|
||
<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>
|
||
</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>
|
||
<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>
|
||
<li class="toctree-l2"><a class="reference internal" href="../writing-plugins.html#internationalization">Internationalization</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../writing-plugins.html#adding-translation-code">Adding translation code</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../writing-plugins.html#generating-qt-translation-files">Generating Qt translation files</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../writing-plugins.html#translating">Translating</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../writing-plugins.html#distributing-translations">Distributing translations</a></li>
|
||
</ul>
|
||
</li>
|
||
</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.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>
|
||
<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.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>
|
||
<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.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>
|
||
<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.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>
|
||
</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> »</li>
|
||
|
||
<li><a href="../mobase.html"><code class="docutils literal notranslate"><span class="pre">mobase</span></code> API</a> »</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 this mod belongs to.</p>
|
||
</dd>
|
||
</dl>
|
||
</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.clearPluginSettings" title="mobase.IModInterface.clearPluginSettings"><code class="xref py py-obj docutils literal notranslate"><span class="pre">clearPluginSettings</span></code></a>(plugin_name)</p></td>
|
||
<td><p>Remove all the settings of the specified plugin this mod.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.color" title="mobase.IModInterface.color"><code class="xref py py-obj docutils literal notranslate"><span class="pre">color</span></code></a>()</p></td>
|
||
<td><p><dl class="field-list simple">
|
||
<dt class="field-odd">returns</dt>
|
||
<dd class="field-odd"><p>The color of the ‘Notes’ column chosen by the user.</p>
|
||
</dd>
|
||
</dl>
|
||
</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.comments" title="mobase.IModInterface.comments"><code class="xref py py-obj docutils literal notranslate"><span class="pre">comments</span></code></a>()</p></td>
|
||
<td><p><dl class="field-list simple">
|
||
<dt class="field-odd">returns</dt>
|
||
<dd class="field-odd"><p>The comments for this mod, if any.</p>
|
||
</dd>
|
||
</dl>
|
||
</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.converted" title="mobase.IModInterface.converted"><code class="xref py py-obj docutils literal notranslate"><span class="pre">converted</span></code></a>()</p></td>
|
||
<td><p>Check if the mod was marked as converted by the user.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.endorsedState" title="mobase.IModInterface.endorsedState"><code class="xref py py-obj docutils literal notranslate"><span class="pre">endorsedState</span></code></a>()</p></td>
|
||
<td><p><dl class="field-list simple">
|
||
<dt class="field-odd">returns</dt>
|
||
<dd class="field-odd"><p>The endorsement state of this mod.</p>
|
||
</dd>
|
||
</dl>
|
||
</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.fileTree" title="mobase.IModInterface.fileTree"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fileTree</span></code></a>()</p></td>
|
||
<td><p>Retrieve a file tree corresponding to the underlying disk content of this mod.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.gameName" title="mobase.IModInterface.gameName"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gameName</span></code></a>()</p></td>
|
||
<td><p>Retrieve the short name of the game associated with this mod.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.ignoredVersion" title="mobase.IModInterface.ignoredVersion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ignoredVersion</span></code></a>()</p></td>
|
||
<td><p><dl class="field-list simple">
|
||
<dt class="field-odd">returns</dt>
|
||
<dd class="field-odd"><p>The ignored version of this mod (for update), or an invalid version if the user</p>
|
||
</dd>
|
||
</dl>
|
||
</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.installationFile" title="mobase.IModInterface.installationFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">installationFile</span></code></a>()</p></td>
|
||
<td><p><dl class="field-list simple">
|
||
<dt class="field-odd">returns</dt>
|
||
<dd class="field-odd"><p>The absolute path to the file that was used to install this mod.</p>
|
||
</dd>
|
||
</dl>
|
||
</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.isBackup" title="mobase.IModInterface.isBackup"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isBackup</span></code></a>()</p></td>
|
||
<td><p><dl class="field-list simple">
|
||
<dt class="field-odd">returns</dt>
|
||
<dd class="field-odd"><p>True if this mod represents a backup.</p>
|
||
</dd>
|
||
</dl>
|
||
</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.isForeign" title="mobase.IModInterface.isForeign"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isForeign</span></code></a>()</p></td>
|
||
<td><p><dl class="field-list simple">
|
||
<dt class="field-odd">returns</dt>
|
||
<dd class="field-odd"><p>True if this mod represents a foreign mod, not managed by MO2.</p>
|
||
</dd>
|
||
</dl>
|
||
</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.isOverwrite" title="mobase.IModInterface.isOverwrite"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isOverwrite</span></code></a>()</p></td>
|
||
<td><p><dl class="field-list simple">
|
||
<dt class="field-odd">returns</dt>
|
||
<dd class="field-odd"><p>True if this mod represents the overwrite mod.</p>
|
||
</dd>
|
||
</dl>
|
||
</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.isSeparator" title="mobase.IModInterface.isSeparator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isSeparator</span></code></a>()</p></td>
|
||
<td><p><dl class="field-list simple">
|
||
<dt class="field-odd">returns</dt>
|
||
<dd class="field-odd"><p>True if this mod represents a separator.</p>
|
||
</dd>
|
||
</dl>
|
||
</p></td>
|
||
</tr>
|
||
<tr class="row-even"><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-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.newestVersion" title="mobase.IModInterface.newestVersion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">newestVersion</span></code></a>()</p></td>
|
||
<td><p><dl class="field-list simple">
|
||
<dt class="field-odd">returns</dt>
|
||
<dd class="field-odd"><p>The newest version of this mod (as known by MO2). If this matches version(),</p>
|
||
</dd>
|
||
</dl>
|
||
</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.nexusId" title="mobase.IModInterface.nexusId"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nexusId</span></code></a>()</p></td>
|
||
<td><p><dl class="field-list simple">
|
||
<dt class="field-odd">returns</dt>
|
||
<dd class="field-odd"><p>The Nexus ID of this mod.</p>
|
||
</dd>
|
||
</dl>
|
||
</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.notes" title="mobase.IModInterface.notes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">notes</span></code></a>()</p></td>
|
||
<td><p><dl class="field-list simple">
|
||
<dt class="field-odd">returns</dt>
|
||
<dd class="field-odd"><p>The notes for this mod, if any.</p>
|
||
</dd>
|
||
</dl>
|
||
</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.pluginSetting" title="mobase.IModInterface.pluginSetting"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pluginSetting</span></code></a>(plugin_name, key[, default])</p></td>
|
||
<td><p>Retrieve the specified setting in this mod for a plugin.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.pluginSettings" title="mobase.IModInterface.pluginSettings"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pluginSettings</span></code></a>(plugin_name)</p></td>
|
||
<td><p>Retrieve the settings in this mod for a plugin.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.primaryCategory" title="mobase.IModInterface.primaryCategory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">primaryCategory</span></code></a>()</p></td>
|
||
<td><p><dl class="field-list simple">
|
||
<dt class="field-odd">returns</dt>
|
||
<dd class="field-odd"><p>The ID of the primary category of this mod.</p>
|
||
</dd>
|
||
</dl>
|
||
</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.repository" title="mobase.IModInterface.repository"><code class="xref py py-obj docutils literal notranslate"><span class="pre">repository</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 the repository from which this mod was installed.</p>
|
||
</dd>
|
||
</dl>
|
||
</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><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-even"><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-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.setPluginSetting" title="mobase.IModInterface.setPluginSetting"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setPluginSetting</span></code></a>(plugin_name, key, value)</p></td>
|
||
<td><p>Set the specified setting in this mod for a plugin.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.setUrl" title="mobase.IModInterface.setUrl"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setUrl</span></code></a>(url)</p></td>
|
||
<td><p>Set the URL 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>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.trackedState" title="mobase.IModInterface.trackedState"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trackedState</span></code></a>()</p></td>
|
||
<td><p><dl class="field-list simple">
|
||
<dt class="field-odd">returns</dt>
|
||
<dd class="field-odd"><p>The tracked state of this mod.</p>
|
||
</dd>
|
||
</dl>
|
||
</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.url" title="mobase.IModInterface.url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">url</span></code></a>()</p></td>
|
||
<td><p><dl class="field-list simple">
|
||
<dt class="field-odd">returns</dt>
|
||
<dd class="field-odd"><p>The URL of this mod, or an empty QString() if no URL is associated</p>
|
||
</dd>
|
||
</dl>
|
||
</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#mobase.IModInterface.validated" title="mobase.IModInterface.validated"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validated</span></code></a>()</p></td>
|
||
<td><p>Check if the mod was marked as validated by the user.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#mobase.IModInterface.version" title="mobase.IModInterface.version"><code class="xref py py-obj docutils literal notranslate"><span class="pre">version</span></code></a>()</p></td>
|
||
<td><p><dl class="field-list simple">
|
||
<dt class="field-odd">returns</dt>
|
||
<dd class="field-odd"><p>The current version of this mod.</p>
|
||
</dd>
|
||
</dl>
|
||
</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 this mod belongs to.</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.clearPluginSettings">
|
||
<code class="sig-name descname">clearPluginSettings</code><span class="sig-paren">(</span><em class="sig-param">plugin_name</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.clearPluginSettings" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Remove all the settings of the specified plugin this mod.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>plugin_name</strong> – Name of the plugin for which settings should be removed. This should always be <cite>IPlugin.name()</cite>
|
||
unless you have a really good reason to access settings of another plugin.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The old settings from the given plugin, as returned by <cite>pluginSettings()</cite>.</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">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code>], <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">str</span></code>, <code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code>]]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="mobase.IModInterface.color">
|
||
<code class="sig-name descname">color</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.color" 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 color of the ‘Notes’ column chosen by the user.</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">QColor</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="mobase.IModInterface.comments">
|
||
<code class="sig-name descname">comments</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.comments" 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 comments for this mod, if any.</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.converted">
|
||
<code class="sig-name descname">converted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.converted" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Check if the mod was marked as converted by the user.</p>
|
||
<p>When a mod is for a different game, a flag is shown to users to warn them, but
|
||
they can mark mods as converted to remove this flag.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>True if this mod was marked as converted by the user.</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.endorsedState">
|
||
<code class="sig-name descname">endorsedState</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.endorsedState" 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 endorsement state of this mod.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="mobase.EndorsedState.html#mobase.EndorsedState" title="mobase.EndorsedState"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndorsedState</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="mobase.IModInterface.fileTree">
|
||
<code class="sig-name descname">fileTree</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.fileTree" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieve a file tree corresponding to the underlying disk content of this mod.</p>
|
||
<p>The file tree should not be cached by plugins since it is already and updated when
|
||
required.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>A file tree representing the content of this mod.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="mobase.IFileTree.html#mobase.IFileTree" title="mobase.IFileTree"><code class="xref py py-class docutils literal notranslate"><span class="pre">IFileTree</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="mobase.IModInterface.gameName">
|
||
<code class="sig-name descname">gameName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.gameName" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieve the short name of the game associated with this mod. This may differ
|
||
from the current game plugin (e.g. you can install a Skyrim LE game in a SSE
|
||
installation).</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The name of the game associated with 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.ignoredVersion">
|
||
<code class="sig-name descname">ignoredVersion</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.ignoredVersion" 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 ignored version of this mod (for update), or an invalid version if the user</p>
|
||
</dd>
|
||
</dl>
|
||
<p>did not ignore version for this mod.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="mobase.VersionInfo.html#mobase.VersionInfo" title="mobase.VersionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="mobase.IModInterface.installationFile">
|
||
<code class="sig-name descname">installationFile</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.installationFile" 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 absolute path to the file that was used to install 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.isBackup">
|
||
<code class="sig-name descname">isBackup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.isBackup" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>True if this mod represents a backup.</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.isForeign">
|
||
<code class="sig-name descname">isForeign</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.isForeign" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>True if this mod represents a foreign mod, not managed by MO2.</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.isOverwrite">
|
||
<code class="sig-name descname">isOverwrite</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.isOverwrite" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>True if this mod represents the overwrite 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">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="mobase.IModInterface.isSeparator">
|
||
<code class="sig-name descname">isSeparator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.isSeparator" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>True if this mod represents a separator.</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.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.newestVersion">
|
||
<code class="sig-name descname">newestVersion</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.newestVersion" 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 newest version of this mod (as known by MO2). If this matches version(),</p>
|
||
</dd>
|
||
</dl>
|
||
<p>then the mod is up-to-date.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="mobase.VersionInfo.html#mobase.VersionInfo" title="mobase.VersionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="mobase.IModInterface.nexusId">
|
||
<code class="sig-name descname">nexusId</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.nexusId" 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 Nexus ID 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">int</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="mobase.IModInterface.notes">
|
||
<code class="sig-name descname">notes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.notes" 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 notes for this mod, if any.</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.pluginSetting">
|
||
<code class="sig-name descname">pluginSetting</code><span class="sig-paren">(</span><em class="sig-param">plugin_name</em>, <em class="sig-param">key</em>, <em class="sig-param">default=None</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.pluginSetting" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieve the specified setting in this mod for a plugin.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>plugin_name</strong> – Name of the plugin for which to retrieve a setting. This should always be <cite>IPlugin.name()</cite>
|
||
unless you have a really good reason to access settings of another plugin.</p></li>
|
||
<li><p><strong>key</strong> – Identifier of the setting.</p></li>
|
||
<li><p><strong>default</strong> – The default value to return if the setting does not exist.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The setting, if found, or the default value.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code>], <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">str</span></code>, <code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code>]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="mobase.IModInterface.pluginSettings">
|
||
<code class="sig-name descname">pluginSettings</code><span class="sig-paren">(</span><em class="sig-param">plugin_name</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.pluginSettings" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieve the settings in this mod for a plugin.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>plugin_name</strong> – Name of the plugin for which to retrieve settings. This should always be <cite>IPlugin.name()</cite>
|
||
unless you have a really good reason to access settings of another plugin.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>A map from setting key to value. The map is empty if there are not settings for this mod.</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">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code>], <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">str</span></code>, <code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code>]]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="mobase.IModInterface.primaryCategory">
|
||
<code class="sig-name descname">primaryCategory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.primaryCategory" 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 ID of the primary category 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">int</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.repository">
|
||
<code class="sig-name descname">repository</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.repository" 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 the repository from which this mod was installed.</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.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.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.setPluginSetting">
|
||
<code class="sig-name descname">setPluginSetting</code><span class="sig-paren">(</span><em class="sig-param">plugin_name</em>, <em class="sig-param">key</em>, <em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.setPluginSetting" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set the specified setting in this mod for a plugin.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>plugin_name</strong> – Name of the plugin for which to retrieve a setting. This should always be <cite>IPlugin.name()</cite>
|
||
unless you have a really good reason to access settings of another plugin.</p></li>
|
||
<li><p><strong>key</strong> – Identifier of the setting.</p></li>
|
||
<li><p><strong>value</strong> – New value for the setting to set.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>True if the setting was set correctly, 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">
|
||
<dt id="mobase.IModInterface.setUrl">
|
||
<code class="sig-name descname">setUrl</code><span class="sig-paren">(</span><em class="sig-param">url</em><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.setUrl" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set the URL of this mod.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>url</strong> – The URL 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>
|
||
|
||
<dl class="method">
|
||
<dt id="mobase.IModInterface.trackedState">
|
||
<code class="sig-name descname">trackedState</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.trackedState" 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 tracked state of this mod.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="mobase.TrackedState.html#mobase.TrackedState" title="mobase.TrackedState"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrackedState</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="mobase.IModInterface.url">
|
||
<code class="sig-name descname">url</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.url" 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 URL of this mod, or an empty QString() if no URL is associated</p>
|
||
</dd>
|
||
</dl>
|
||
<p>with this mod.</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">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="mobase.IModInterface.validated">
|
||
<code class="sig-name descname">validated</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.validated" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Check if the mod was marked as validated by the user.</p>
|
||
<p>MO2 uses ModDataChecker to check the content of mods, but sometimes these fail, in
|
||
which case mods are incorrectly marked as ‘not containing valid games data’. Users can
|
||
choose to mark these mods as valid to hide the warning / flag.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>True if th is mod was marked as containing valid game data.</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.version">
|
||
<code class="sig-name descname">version</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mobase.IModInterface.version" 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 current version of this mod.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="mobase.VersionInfo.html#mobase.VersionInfo" title="mobase.VersionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></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" aria-hidden="true"></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" aria-hidden="true"></span> Previous</a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2020, Holt59.
|
||
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using 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>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |