2020-09-24 13:47:11 +00:00
<!DOCTYPE html>
< html class = "writer-html5" lang = "en" >
< head >
2023-09-20 17:06:52 +00:00
< meta charset = "utf-8" />< meta name = "generator" content = "Docutils 0.18.1: http://docutils.sourceforge.net/" />
2021-01-18 21:09:43 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" />
2023-09-20 17:06:52 +00:00
< title > ModDataChecker — MO2 Python Plugin API documentation</ title >
< link rel = "stylesheet" href = "../_static/pygments.css" type = "text/css" />
< link rel = "stylesheet" href = "../_static/css/theme.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]-->
2023-09-20 17:06:52 +00:00
< script src = "../_static/jquery.js?v=5d32c60e" ></ script >
< script src = "../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c" ></ script >
< script src = "../_static/documentation_options.js?v=5929fcd5" ></ script >
< script src = "../_static/doctools.js?v=888ff710" ></ script >
< script src = "../_static/sphinx_highlight.js?v=dc90522c" ></ script >
< script src = "../_static/js/theme.js" ></ script >
2020-09-24 13:47:11 +00:00
< link rel = "index" title = "Index" href = "../genindex.html" />
< link rel = "search" title = "Search" href = "../search.html" />
< link rel = "next" title = "ModDataContent" href = "mobase.ModDataContent.html" />
< link rel = "prev" title = "Mapping" href = "mobase.Mapping.html" />
</ head >
2023-09-20 17:06:52 +00:00
< body class = "wy-body-for-nav" >
2020-09-24 13:47:11 +00:00
< 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" >
2023-09-20 17:06:52 +00:00
< a href = "../index.html" class = "icon icon-home" >
MO2 Python Plugin API
2020-09-24 13:47:11 +00:00
</ a >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../search.html" method = "get" >
2023-09-20 17:06:52 +00:00
< input type = "text" name = "q" placeholder = "Search docs" aria-label = "Search docs" />
2020-09-24 13:47:11 +00:00
< input type = "hidden" name = "check_keywords" value = "yes" />
< input type = "hidden" name = "area" value = "default" />
</ form >
</ div >
2023-09-20 17:06:52 +00:00
</ div >< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "Navigation menu" >
< p class = "caption" role = "heading" >< span class = "caption-text" > Contents:</ span ></ p >
2020-09-24 13:47:11 +00:00
< 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 >
2021-02-26 18:26:36 +00:00
< li class = "toctree-l3" >< a class = "reference internal" href = "../setup-tools.html#optional-configure-black-to-auto-format-your-source-files" > 3. [Optional] Configure < code class = "docutils literal notranslate" >< span class = "pre" > black</ span ></ code > to auto-format your source files</ a ></ li >
2021-01-18 21:09:43 +00:00
< 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 >
2020-09-24 13:47:11 +00:00
</ 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 >
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 >
2021-02-06 18:58:42 +00:00
< 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 >
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 >
2023-09-20 17:06:52 +00:00
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.getFileVersion.html" > getFileVersion</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.getFileVersion.html#mobase.getFileVersion" >< code class = "docutils literal notranslate" >< span class = "pre" > getFileVersion()</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.getIconForExecutable.html" > getIconForExecutable</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.getIconForExecutable.html#mobase.getIconForExecutable" >< code class = "docutils literal notranslate" >< span class = "pre" > getIconForExecutable()</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.getProductVersion.html" > getProductVersion</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.getProductVersion.html#mobase.getProductVersion" >< code class = "docutils literal notranslate" >< span class = "pre" > getProductVersion()</ span ></ code ></ a ></ li >
</ ul >
</ li >
2020-09-24 13:47:11 +00:00
</ ul >
</ li >
< li class = "toctree-l2 current" >< a class = "reference internal" href = "../mobase.html#classes" > Classes</ a >< ul class = "current" >
2023-09-20 17:06:52 +00:00
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.BSAInvalidation.html" > BSAInvalidation</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.BSAInvalidation.html#mobase.BSAInvalidation" >< code class = "docutils literal notranslate" >< span class = "pre" > BSAInvalidation</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.DataArchives.html" > DataArchives</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.DataArchives.html#mobase.DataArchives" >< code class = "docutils literal notranslate" >< span class = "pre" > DataArchives</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.EndorsedState.html" > EndorsedState</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.EndorsedState.html#mobase.EndorsedState" >< code class = "docutils literal notranslate" >< span class = "pre" > EndorsedState</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ExecutableForcedLoadSetting.html" > ExecutableForcedLoadSetting</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.ExecutableForcedLoadSetting.html#mobase.ExecutableForcedLoadSetting" >< code class = "docutils literal notranslate" >< span class = "pre" > ExecutableForcedLoadSetting</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ExecutableInfo.html" > ExecutableInfo</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.ExecutableInfo.html#mobase.ExecutableInfo" >< code class = "docutils literal notranslate" >< span class = "pre" > ExecutableInfo</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.FileInfo.html" > FileInfo</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.FileInfo.html#mobase.FileInfo" >< code class = "docutils literal notranslate" >< span class = "pre" > FileInfo</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.FileTreeEntry.html" > FileTreeEntry</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.FileTreeEntry.html#mobase.FileTreeEntry" >< code class = "docutils literal notranslate" >< span class = "pre" > FileTreeEntry</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.GamePlugins.html" > GamePlugins</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.GamePlugins.html#mobase.GamePlugins" >< code class = "docutils literal notranslate" >< span class = "pre" > GamePlugins</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.GuessQuality.html" > GuessQuality</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.GuessQuality.html#mobase.GuessQuality" >< code class = "docutils literal notranslate" >< span class = "pre" > GuessQuality</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.GuessedString.html" > GuessedString</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.GuessedString.html#mobase.GuessedString" >< code class = "docutils literal notranslate" >< span class = "pre" > GuessedString</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IDownloadManager.html" > IDownloadManager</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IDownloadManager.html#mobase.IDownloadManager" >< code class = "docutils literal notranslate" >< span class = "pre" > IDownloadManager</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IFileTree.html" > IFileTree</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IFileTree.html#mobase.IFileTree" >< code class = "docutils literal notranslate" >< span class = "pre" > IFileTree</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IInstallationManager.html" > IInstallationManager</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IInstallationManager.html#mobase.IInstallationManager" >< code class = "docutils literal notranslate" >< span class = "pre" > IInstallationManager</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IModInterface.html" > IModInterface</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IModInterface.html#mobase.IModInterface" >< code class = "docutils literal notranslate" >< span class = "pre" > IModInterface</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IModList.html" > IModList</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IModList.html#mobase.IModList" >< code class = "docutils literal notranslate" >< span class = "pre" > IModList</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IModRepositoryBridge.html" > IModRepositoryBridge</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IModRepositoryBridge.html#mobase.IModRepositoryBridge" >< code class = "docutils literal notranslate" >< span class = "pre" > IModRepositoryBridge</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IOrganizer.html" > IOrganizer</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IOrganizer.html#mobase.IOrganizer" >< code class = "docutils literal notranslate" >< span class = "pre" > IOrganizer</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPlugin.html" > IPlugin</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IPlugin.html#mobase.IPlugin" >< code class = "docutils literal notranslate" >< span class = "pre" > IPlugin</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginDiagnose.html" > IPluginDiagnose</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IPluginDiagnose.html#mobase.IPluginDiagnose" >< code class = "docutils literal notranslate" >< span class = "pre" > IPluginDiagnose</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginFileMapper.html" > IPluginFileMapper</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IPluginFileMapper.html#mobase.IPluginFileMapper" >< code class = "docutils literal notranslate" >< span class = "pre" > IPluginFileMapper</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginGame.html" > IPluginGame</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IPluginGame.html#mobase.IPluginGame" >< code class = "docutils literal notranslate" >< span class = "pre" > IPluginGame</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginInstaller.html" > IPluginInstaller</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IPluginInstaller.html#mobase.IPluginInstaller" >< code class = "docutils literal notranslate" >< span class = "pre" > IPluginInstaller</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginInstallerCustom.html" > IPluginInstallerCustom</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IPluginInstallerCustom.html#mobase.IPluginInstallerCustom" >< code class = "docutils literal notranslate" >< span class = "pre" > IPluginInstallerCustom</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginInstallerSimple.html" > IPluginInstallerSimple</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IPluginInstallerSimple.html#mobase.IPluginInstallerSimple" >< code class = "docutils literal notranslate" >< span class = "pre" > IPluginInstallerSimple</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginList.html" > IPluginList</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IPluginList.html#mobase.IPluginList" >< code class = "docutils literal notranslate" >< span class = "pre" > IPluginList</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginModPage.html" > IPluginModPage</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IPluginModPage.html#mobase.IPluginModPage" >< code class = "docutils literal notranslate" >< span class = "pre" > IPluginModPage</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginPreview.html" > IPluginPreview</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IPluginPreview.html#mobase.IPluginPreview" >< code class = "docutils literal notranslate" >< span class = "pre" > IPluginPreview</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginRequirement.html" > IPluginRequirement</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IPluginRequirement.html#mobase.IPluginRequirement" >< code class = "docutils literal notranslate" >< span class = "pre" > IPluginRequirement</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IPluginTool.html" > IPluginTool</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IPluginTool.html#mobase.IPluginTool" >< code class = "docutils literal notranslate" >< span class = "pre" > IPluginTool</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.IProfile.html" > IProfile</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.IProfile.html#mobase.IProfile" >< code class = "docutils literal notranslate" >< span class = "pre" > IProfile</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ISaveGame.html" > ISaveGame</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.ISaveGame.html#mobase.ISaveGame" >< code class = "docutils literal notranslate" >< span class = "pre" > ISaveGame</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ISaveGameInfoWidget.html" > ISaveGameInfoWidget</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.ISaveGameInfoWidget.html#mobase.ISaveGameInfoWidget" >< code class = "docutils literal notranslate" >< span class = "pre" > ISaveGameInfoWidget</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.InstallResult.html" > InstallResult</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.InstallResult.html#mobase.InstallResult" >< code class = "docutils literal notranslate" >< span class = "pre" > InstallResult</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.LoadOrderMechanism.html" > LoadOrderMechanism</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.LoadOrderMechanism.html#mobase.LoadOrderMechanism" >< code class = "docutils literal notranslate" >< span class = "pre" > LoadOrderMechanism</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.LocalSavegames.html" > LocalSavegames</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.LocalSavegames.html#mobase.LocalSavegames" >< code class = "docutils literal notranslate" >< span class = "pre" > LocalSavegames</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.Mapping.html" > Mapping</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.Mapping.html#mobase.Mapping" >< code class = "docutils literal notranslate" >< span class = "pre" > Mapping</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3 current" >< a class = "current reference internal" href = "#" > ModDataChecker</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "#mobase.ModDataChecker" >< code class = "docutils literal notranslate" >< span class = "pre" > ModDataChecker</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ModDataContent.html" > ModDataContent</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.ModDataContent.html#mobase.ModDataContent" >< code class = "docutils literal notranslate" >< span class = "pre" > ModDataContent</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ModRepositoryFileInfo.html" > ModRepositoryFileInfo</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.ModRepositoryFileInfo.html#mobase.ModRepositoryFileInfo" >< code class = "docutils literal notranslate" >< span class = "pre" > ModRepositoryFileInfo</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ModState.html" > ModState</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.ModState.html#mobase.ModState" >< code class = "docutils literal notranslate" >< span class = "pre" > ModState</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.PluginRequirementFactory.html" > PluginRequirementFactory</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.PluginRequirementFactory.html#mobase.PluginRequirementFactory" >< code class = "docutils literal notranslate" >< span class = "pre" > PluginRequirementFactory</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.PluginSetting.html" > PluginSetting</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.PluginSetting.html#mobase.PluginSetting" >< code class = "docutils literal notranslate" >< span class = "pre" > PluginSetting</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.PluginState.html" > PluginState</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.PluginState.html#mobase.PluginState" >< code class = "docutils literal notranslate" >< span class = "pre" > PluginState</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ProfileSetting.html" > ProfileSetting</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.ProfileSetting.html#mobase.ProfileSetting" >< code class = "docutils literal notranslate" >< span class = "pre" > ProfileSetting</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ReleaseType.html" > ReleaseType</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.ReleaseType.html#mobase.ReleaseType" >< code class = "docutils literal notranslate" >< span class = "pre" > ReleaseType</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.SaveGameInfo.html" > SaveGameInfo</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.SaveGameInfo.html#mobase.SaveGameInfo" >< code class = "docutils literal notranslate" >< span class = "pre" > SaveGameInfo</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.ScriptExtender.html" > ScriptExtender</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.ScriptExtender.html#mobase.ScriptExtender" >< code class = "docutils literal notranslate" >< span class = "pre" > ScriptExtender</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.SortMechanism.html" > SortMechanism</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.SortMechanism.html#mobase.SortMechanism" >< code class = "docutils literal notranslate" >< span class = "pre" > SortMechanism</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.TrackedState.html" > TrackedState</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.TrackedState.html#mobase.TrackedState" >< code class = "docutils literal notranslate" >< span class = "pre" > TrackedState</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.UnmanagedMods.html" > UnmanagedMods</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.UnmanagedMods.html#mobase.UnmanagedMods" >< code class = "docutils literal notranslate" >< span class = "pre" > UnmanagedMods</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.VersionInfo.html" > VersionInfo</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.VersionInfo.html#mobase.VersionInfo" >< code class = "docutils literal notranslate" >< span class = "pre" > VersionInfo</ span ></ code ></ a ></ li >
</ ul >
</ li >
< li class = "toctree-l3" >< a class = "reference internal" href = "mobase.VersionScheme.html" > VersionScheme</ a >< ul >
< li class = "toctree-l4" >< a class = "reference internal" href = "mobase.VersionScheme.html#mobase.VersionScheme" >< code class = "docutils literal notranslate" >< span class = "pre" > VersionScheme</ span ></ code ></ a ></ li >
</ ul >
</ li >
2020-09-24 13:47:11 +00:00
</ ul >
</ li >
</ ul >
</ li >
</ ul >
</ div >
</ div >
</ nav >
2023-09-20 17:06:52 +00:00
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >< nav class = "wy-nav-top" aria-label = "Mobile navigation menu" >
2020-09-24 13:47:11 +00:00
< 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" >
2023-09-20 17:06:52 +00:00
< div role = "navigation" aria-label = "Page navigation" >
2020-09-24 13:47:11 +00:00
< ul class = "wy-breadcrumbs" >
2023-09-20 17:06:52 +00:00
< li >< a href = "../index.html" class = "icon icon-home" aria-label = "Home" ></ a ></ li >
< li class = "breadcrumb-item" >< a href = "../mobase.html" >< code class = "docutils literal notranslate" >< span class = "pre" > mobase</ span ></ code > API</ a ></ li >
< li class = "breadcrumb-item active" > ModDataChecker</ li >
2020-09-24 13:47:11 +00:00
< li class = "wy-breadcrumbs-aside" >
< a href = "../_sources/api/mobase.ModDataChecker.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" >
2023-09-20 17:06:52 +00:00
< section id = "moddatachecker" >
< h1 > ModDataChecker< a class = "headerlink" href = "#moddatachecker" title = "Link to this heading" > </ a ></ h1 >
< dl class = "py class" >
< dt class = "sig sig-object py" id = "mobase.ModDataChecker" >
< em class = "property" >< span class = "pre" > class</ span >< span class = "w" > </ span ></ em >< span class = "sig-prename descclassname" >< span class = "pre" > mobase.</ span ></ span >< span class = "sig-name descname" >< span class = "pre" > ModDataChecker</ span ></ span >< a class = "headerlink" href = "#mobase.ModDataChecker" title = "Link to this definition" > </ a ></ dt >
< dd >< p > Bases: < code class = "xref py py-class docutils literal notranslate" >< span class = "pre" > ABC</ span ></ code ></ p >
2020-09-24 13:47:11 +00:00
< p > Game feature that is used to check the content of a data tree.</ p >
< p class = "rubric" > Attributes Summary</ p >
2023-09-20 17:06:52 +00:00
< table class = "autosummary longtable docutils align-default" >
2020-09-24 13:47:11 +00:00
< tbody >
< tr class = "row-odd" >< td >< p >< a class = "reference internal" href = "#mobase.ModDataChecker.FIXABLE" title = "mobase.ModDataChecker.FIXABLE" >< code class = "xref py py-obj docutils literal notranslate" >< span class = "pre" > FIXABLE</ span ></ code ></ a ></ p ></ td >
< td >< p ></ p ></ td >
</ tr >
< tr class = "row-even" >< td >< p >< a class = "reference internal" href = "#mobase.ModDataChecker.INVALID" title = "mobase.ModDataChecker.INVALID" >< code class = "xref py py-obj docutils literal notranslate" >< span class = "pre" > INVALID</ span ></ code ></ a ></ p ></ td >
< td >< p ></ p ></ td >
</ tr >
< tr class = "row-odd" >< td >< p >< a class = "reference internal" href = "#mobase.ModDataChecker.VALID" title = "mobase.ModDataChecker.VALID" >< code class = "xref py py-obj docutils literal notranslate" >< span class = "pre" > VALID</ span ></ code ></ a ></ p ></ td >
< td >< p ></ p ></ td >
</ tr >
</ tbody >
</ table >
< p class = "rubric" > Methods Summary</ p >
2023-09-20 17:06:52 +00:00
< table class = "autosummary longtable docutils align-default" >
2020-09-24 13:47:11 +00:00
< tbody >
< tr class = "row-odd" >< td >< p >< a class = "reference internal" href = "#mobase.ModDataChecker.dataLooksValid" title = "mobase.ModDataChecker.dataLooksValid" >< code class = "xref py py-obj docutils literal notranslate" >< span class = "pre" > dataLooksValid</ span ></ code ></ a > (filetree)</ p ></ td >
< td >< p > Check that the given filetree represent a valid mod layout, or can be easily fixed.</ p ></ td >
</ tr >
< tr class = "row-even" >< td >< p >< a class = "reference internal" href = "#mobase.ModDataChecker.fix" title = "mobase.ModDataChecker.fix" >< code class = "xref py py-obj docutils literal notranslate" >< span class = "pre" > fix</ span ></ code ></ a > (filetree)</ p ></ td >
< td >< p > Try to fix the given tree.</ p ></ td >
</ tr >
</ tbody >
</ table >
< p class = "rubric" > Attributes Documentation</ p >
2023-09-20 17:06:52 +00:00
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "mobase.ModDataChecker.FIXABLE" >
< span class = "sig-name descname" >< span class = "pre" > FIXABLE</ span ></ span >< em class = "property" >< span class = "p" >< span class = "pre" > :</ span ></ span >< span class = "w" > </ span >< span class = "pre" > CheckReturn</ span ></ em >< em class = "property" >< span class = "w" > </ span >< span class = "p" >< span class = "pre" > =</ span ></ span >< span class = "w" > </ span >< span class = "pre" > Ellipsis</ span ></ em >< a class = "headerlink" href = "#mobase.ModDataChecker.FIXABLE" title = "Link to this definition" > </ a ></ dt >
2020-09-24 13:47:11 +00:00
< dd ></ dd ></ dl >
2023-09-20 17:06:52 +00:00
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "mobase.ModDataChecker.INVALID" >
< span class = "sig-name descname" >< span class = "pre" > INVALID</ span ></ span >< em class = "property" >< span class = "p" >< span class = "pre" > :</ span ></ span >< span class = "w" > </ span >< span class = "pre" > CheckReturn</ span ></ em >< em class = "property" >< span class = "w" > </ span >< span class = "p" >< span class = "pre" > =</ span ></ span >< span class = "w" > </ span >< span class = "pre" > Ellipsis</ span ></ em >< a class = "headerlink" href = "#mobase.ModDataChecker.INVALID" title = "Link to this definition" > </ a ></ dt >
2020-09-24 13:47:11 +00:00
< dd ></ dd ></ dl >
2023-09-20 17:06:52 +00:00
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "mobase.ModDataChecker.VALID" >
< span class = "sig-name descname" >< span class = "pre" > VALID</ span ></ span >< em class = "property" >< span class = "p" >< span class = "pre" > :</ span ></ span >< span class = "w" > </ span >< span class = "pre" > CheckReturn</ span ></ em >< em class = "property" >< span class = "w" > </ span >< span class = "p" >< span class = "pre" > =</ span ></ span >< span class = "w" > </ span >< span class = "pre" > Ellipsis</ span ></ em >< a class = "headerlink" href = "#mobase.ModDataChecker.VALID" title = "Link to this definition" > </ a ></ dt >
2020-09-24 13:47:11 +00:00
< dd ></ dd ></ dl >
< p class = "rubric" > Methods Documentation</ p >
2023-09-20 17:06:52 +00:00
< dl class = "py method" >
< dt class = "sig sig-object py" id = "mobase.ModDataChecker.dataLooksValid" >
< em class = "property" >< span class = "pre" > abstract</ span >< span class = "w" > </ span ></ em >< span class = "sig-name descname" >< span class = "pre" > dataLooksValid</ span ></ span >< span class = "sig-paren" > (</ span >< em class = "sig-param" >< span class = "n" >< span class = "pre" > filetree</ span ></ span ></ em >< span class = "sig-paren" > )</ span >< a class = "headerlink" href = "#mobase.ModDataChecker.dataLooksValid" title = "Link to this definition" > </ a ></ dt >
2020-09-24 13:47:11 +00:00
< dd >< p > Check that the given filetree represent a valid mod layout, or can be easily
fixed.</ p >
< p > This method is mainly used during installation (to find which installer should
be used or to recurse into multi-level archives), or to quickly indicates to a
user if a mod looks valid.</ p >
< p > This method does not have to be exact, it only has to indicate if the given tree
looks like a valid mod or not by quickly checking the structure (heavy operations
should be avoided).</ p >
< p > If the tree can be fixed by the < cite > fix()</ cite > method, this method should return < cite > FIXABLE</ cite > .
< cite > FIXABLE</ cite > should only be returned when it is guaranteed that < cite > fix()</ cite > can fix the tree.</ p >
< dl class = "field-list simple" >
2023-09-20 17:06:52 +00:00
< dt class = "field-odd" > Return type< span class = "colon" > :</ span ></ dt >
2020-09-24 13:47:11 +00:00
< dd class = "field-odd" >< p >< code class = "xref py py-class docutils literal notranslate" >< span class = "pre" > CheckReturn</ span ></ code ></ p >
</ dd >
2023-09-20 17:06:52 +00:00
< dt class = "field-even" > Parameters< span class = "colon" > :</ span ></ dt >
< dd class = "field-even" >< p >< strong > filetree</ strong > – </ p >
</ dd >
< dt class = "field-odd" > Returns< span class = "colon" > :</ span ></ dt >
< dd class = "field-odd" >< p > Whether the tree is invalid, fixable or valid.</ p >
</ dd >
2020-09-24 13:47:11 +00:00
</ dl >
</ dd ></ dl >
2023-09-20 17:06:52 +00:00
< dl class = "py method" >
< dt class = "sig sig-object py" id = "mobase.ModDataChecker.fix" >
< span class = "sig-name descname" >< span class = "pre" > fix</ span ></ span >< span class = "sig-paren" > (</ span >< em class = "sig-param" >< span class = "n" >< span class = "pre" > filetree</ span ></ span ></ em >< span class = "sig-paren" > )</ span >< a class = "headerlink" href = "#mobase.ModDataChecker.fix" title = "Link to this definition" > </ a ></ dt >
2020-09-24 13:47:11 +00:00
< dd >< p > Try to fix the given tree.</ p >
< p > This method is used during installation to try to fix invalid archives and will only be
called if dataLooksValid returned < cite > FIXABLE</ cite > .</ p >
< dl class = "field-list simple" >
2023-09-20 17:06:52 +00:00
< dt class = "field-odd" > Return type< span class = "colon" > :</ span ></ dt >
2020-09-24 13:47:11 +00:00
< dd class = "field-odd" >< p >< code class = "xref py py-data docutils literal notranslate" >< span class = "pre" > Optional</ span ></ code > [< 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 >
2023-09-20 17:06:52 +00:00
< dt class = "field-even" > Parameters< span class = "colon" > :</ span ></ dt >
< dd class = "field-even" >< p >< strong > filetree</ strong > – </ p >
</ dd >
< dt class = "field-odd" > Returns< span class = "colon" > :</ span ></ dt >
< dd class = "field-odd" >< p > The fixed tree, or a null pointer if the tree could not be fixed.</ p >
</ dd >
2020-09-24 13:47:11 +00:00
</ dl >
</ dd ></ dl >
</ dd ></ dl >
2023-09-20 17:06:52 +00:00
</ section >
2020-09-24 13:47:11 +00:00
</ div >
</ div >
2023-09-20 17:06:52 +00:00
< footer >< div class = "rst-footer-buttons" role = "navigation" aria-label = "Footer" >
2021-01-18 21:09:43 +00:00
< a href = "mobase.Mapping.html" class = "btn btn-neutral float-left" title = "Mapping" accesskey = "p" rel = "prev" >< span class = "fa fa-arrow-circle-left" aria-hidden = "true" ></ span > Previous</ a >
2023-09-20 17:06:52 +00:00
< a href = "mobase.ModDataContent.html" class = "btn btn-neutral float-right" title = "ModDataContent" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" ></ span ></ a >
2020-09-24 13:47:11 +00:00
</ div >
< hr />
< div role = "contentinfo" >
2023-09-20 17:06:52 +00:00
< p > © Copyright 2023, Holt59.</ p >
2020-09-24 13:47:11 +00:00
</ div >
2023-09-20 17:06:52 +00:00
Built with < a href = "https://www.sphinx-doc.org/" > Sphinx</ a > using a
2021-01-18 21:09:43 +00:00
< a href = "https://github.com/readthedocs/sphinx_rtd_theme" > theme</ a >
2023-09-20 17:06:52 +00:00
provided by < a href = "https://readthedocs.org" > Read the Docs</ a > .
2020-09-24 13:47:11 +00:00
</ footer >
</ div >
</ div >
</ section >
</ div >
2023-09-20 17:06:52 +00:00
< script >
2020-09-24 13:47:11 +00:00
jQuery ( function () {
SphinxRtdTheme . Navigation . enable ( true );
});
2023-09-20 17:06:52 +00:00
</ script >
2020-09-24 13:47:11 +00:00
</ body >
</ html >
