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 > IPluginInstallerSimple — 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" />
2020-09-24 14:17:15 +00:00
< link rel = "shortcut icon" href = "../_static/mo2.ico" />
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 = "IPluginList" href = "mobase.IPluginList.html" />
< link rel = "prev" title = "IPluginInstallerCustom" href = "mobase.IPluginInstallerCustom.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 >
</ 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" >< a class = "reference internal" href = "mobase.IModInterface.html" > 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 current" >< a class = "current reference internal" href = "#" > 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 > » </ li >
< li >< a href = "../mobase.html" >< code class = "docutils literal notranslate" >< span class = "pre" > mobase</ span ></ code > API</ a > » </ li >
< li > IPluginInstallerSimple</ li >
< li class = "wy-breadcrumbs-aside" >
< a href = "../_sources/api/mobase.IPluginInstallerSimple.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 = "iplugininstallersimple" >
< h1 > IPluginInstallerSimple< a class = "headerlink" href = "#iplugininstallersimple" title = "Permalink to this headline" > ¶</ a ></ h1 >
< dl class = "class" >
< dt id = "mobase.IPluginInstallerSimple" >
< em class = "property" > class </ em >< code class = "sig-prename descclassname" > mobase.</ code >< code class = "sig-name descname" > IPluginInstallerSimple</ code >< a class = "headerlink" href = "#mobase.IPluginInstallerSimple" title = "Permalink to this definition" > ¶</ a ></ dt >
< dd >< p > Bases: < a class = "reference internal" href = "mobase.IPluginInstaller.html#mobase.IPluginInstaller" title = "mobase.IPluginInstaller" >< code class = "xref py py-class docutils literal notranslate" >< span class = "pre" > mobase.IPluginInstaller</ span ></ code ></ a ></ p >
< p > Simple installer for mods. Simple installers only deal with an in-memory structure
representing the archive and can modify what to install and where by editing this structure.
Actually extracting the archive is handled by the manager.</ 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.IPluginInstallerSimple.install" title = "mobase.IPluginInstallerSimple.install" >< code class = "xref py py-obj docutils literal notranslate" >< span class = "pre" > install</ span ></ code ></ a > (name,   </ p ></ td >
< td >< p > Install a mod from an archive filetree.</ p ></ td >
</ tr >
</ tbody >
</ table >
< p class = "rubric" > Methods Documentation</ p >
< dl class = "method" >
< dt id = "mobase.IPluginInstallerSimple.install" >
< em class = "property" > abstract </ em >< code class = "sig-name descname" > install</ code >< span class = "sig-paren" > (</ span >< em class = "sig-param" > name</ em > , < em class = "sig-param" > tree</ em > , < em class = "sig-param" > version</ em > , < em class = "sig-param" > nexus_id</ em >< span class = "sig-paren" > )</ span >< a class = "headerlink" href = "#mobase.IPluginInstallerSimple.install" title = "Permalink to this definition" > ¶</ a ></ dt >
< dd >< p > Install a mod from an archive filetree.</ p >
< p > The installer can modify the given tree and use the manager to extract or create new
files.</ p >
< p > This method returns different type of objects depending on the actual result of the
installation. The C++ bindings for this method always returns a tuple (result, tree,
version, id).</ p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters</ dt >
< dd class = "field-odd" >< ul class = "simple" >
< li >< p >< strong > name</ strong > – </ p ></ li >
< li >< p >< strong > tree</ strong > – </ p ></ li >
< li >< p >< strong > version</ strong > – </ p ></ li >
< li >< p >< strong > nexus_id</ strong > – </ p ></ li >
</ ul >
</ dd >
< dt class = "field-even" > Returns</ dt >
< dd class = "field-even" >< p > In case of failure, the result of the installation, otherwise the modified tree or</ p >
</ dd >
</ dl >
< p > a tuple (result, tree, version, id) containing the result of the installation, the
modified tree, the new version and the new ID. The tuple can be returned even if the
installation did not succeed.</ p >
< dl class = "field-list simple" >
< 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 > [< a class = "reference internal" href = "mobase.InstallResult.html#mobase.InstallResult" title = "mobase.InstallResult" >< code class = "xref py py-class docutils literal notranslate" >< span class = "pre" > InstallResult</ span ></ code ></ a > , < 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 > , < code class = "xref py py-data docutils literal notranslate" >< span class = "pre" > Tuple</ span ></ code > [< a class = "reference internal" href = "mobase.InstallResult.html#mobase.InstallResult" title = "mobase.InstallResult" >< code class = "xref py py-class docutils literal notranslate" >< span class = "pre" > InstallResult</ span ></ code ></ a > , < 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 > , < 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" > int</ span ></ code > ]]</ 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.IPluginList.html" class = "btn btn-neutral float-right" title = "IPluginList" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" ></ span ></ a >
< a href = "mobase.IPluginInstallerCustom.html" class = "btn btn-neutral float-left" title = "IPluginInstallerCustom" accesskey = "p" rel = "prev" >< span class = "fa fa-arrow-circle-left" ></ span > Previous</ a >
</ div >
< hr />
< div role = "contentinfo" >
< p >
© 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 >
