mo2/python-plugins-doc
0
0
Fork 0
mirror of https://github.com/ModOrganizer2/python-plugins-doc.git synced 2026-07-27 14:07:44 -07:00
Code Issues Packages Projects Releases Wiki Activity

Deploying to master from @ ModOrganizer2/pystubs-generation@dd80b67a0a 🚀

Browse Source
This commit is contained in:
Holt59
2024-08-09 08:57:44 +00:00
parent 1739c60009
commit 96b156adb7
200 changed files with 15431 additions and 36358 deletions
Download Patch File Download Diff File Expand all files Collapse all files
_sources/api/mobase.BSAInvalidation.rst.txt
-21
View File
@@ -1,21 +0,0 @@
BSAInvalidation
===============
.. currentmodule:: mobase
.. autoclass:: BSAInvalidation
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~BSAInvalidation.activate
~BSAInvalidation.deactivate
~BSAInvalidation.isInvalidationBSA
.. rubric:: Methods Documentation
.. automethod:: activate
.. automethod:: deactivate
.. automethod:: isInvalidationBSA
_sources/api/mobase.DataArchives.rst.txt
-23
View File
@@ -1,23 +0,0 @@
DataArchives
============
.. currentmodule:: mobase
.. autoclass:: DataArchives
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~DataArchives.addArchive
~DataArchives.archives
~DataArchives.removeArchive
~DataArchives.vanillaArchives
.. rubric:: Methods Documentation
.. automethod:: addArchive
.. automethod:: archives
.. automethod:: removeArchive
.. automethod:: vanillaArchives
_sources/api/mobase.EndorsedState.rst.txt
-27
View File
@@ -1,27 +0,0 @@
EndorsedState
=============
.. currentmodule:: mobase
.. autoclass:: EndorsedState
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~EndorsedState.ENDORSED_FALSE
~EndorsedState.ENDORSED_NEVER
~EndorsedState.ENDORSED_TRUE
~EndorsedState.ENDORSED_UNKNOWN
~EndorsedState.name
~EndorsedState.value
.. rubric:: Attributes Documentation
.. autoattribute:: ENDORSED_FALSE
.. autoattribute:: ENDORSED_NEVER
.. autoattribute:: ENDORSED_TRUE
.. autoattribute:: ENDORSED_UNKNOWN
.. autoattribute:: name
.. autoattribute:: value
_sources/api/mobase.ExecutableForcedLoadSetting.rst.txt
-27
View File
@@ -1,27 +0,0 @@
ExecutableForcedLoadSetting
===========================
.. currentmodule:: mobase
.. autoclass:: ExecutableForcedLoadSetting
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~ExecutableForcedLoadSetting.enabled
~ExecutableForcedLoadSetting.forced
~ExecutableForcedLoadSetting.library
~ExecutableForcedLoadSetting.process
~ExecutableForcedLoadSetting.withEnabled
~ExecutableForcedLoadSetting.withForced
.. rubric:: Methods Documentation
.. automethod:: enabled
.. automethod:: forced
.. automethod:: library
.. automethod:: process
.. automethod:: withEnabled
.. automethod:: withForced
_sources/api/mobase.ExecutableInfo.rst.txt
-37
View File
@@ -1,37 +0,0 @@
ExecutableInfo
==============
.. currentmodule:: mobase
.. autoclass:: ExecutableInfo
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~ExecutableInfo.arguments
~ExecutableInfo.asCustom
~ExecutableInfo.binary
~ExecutableInfo.isCustom
~ExecutableInfo.isValid
~ExecutableInfo.steamAppID
~ExecutableInfo.title
~ExecutableInfo.withArgument
~ExecutableInfo.withSteamAppId
~ExecutableInfo.withWorkingDirectory
~ExecutableInfo.workingDirectory
.. rubric:: Methods Documentation
.. automethod:: arguments
.. automethod:: asCustom
.. automethod:: binary
.. automethod:: isCustom
.. automethod:: isValid
.. automethod:: steamAppID
.. automethod:: title
.. automethod:: withArgument
.. automethod:: withSteamAppId
.. automethod:: withWorkingDirectory
.. automethod:: workingDirectory
_sources/api/mobase.FileInfo.rst.txt
-21
View File
@@ -1,21 +0,0 @@
FileInfo
========
.. currentmodule:: mobase
.. autoclass:: FileInfo
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~FileInfo.archive
~FileInfo.filePath
~FileInfo.origins
.. rubric:: Attributes Documentation
.. autoattribute:: archive
.. autoattribute:: filePath
.. autoattribute:: origins
_sources/api/mobase.FileTreeEntry.rst.txt
-51
View File
@@ -1,51 +0,0 @@
FileTreeEntry
=============
.. currentmodule:: mobase
.. autoclass:: FileTreeEntry
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~FileTreeEntry.DIRECTORY
~FileTreeEntry.FILE
~FileTreeEntry.FILE_OR_DIRECTORY
.. rubric:: Methods Summary
.. autosummary::
~FileTreeEntry.detach
~FileTreeEntry.fileType
~FileTreeEntry.hasSuffix
~FileTreeEntry.isDir
~FileTreeEntry.isFile
~FileTreeEntry.moveTo
~FileTreeEntry.name
~FileTreeEntry.parent
~FileTreeEntry.path
~FileTreeEntry.pathFrom
~FileTreeEntry.suffix
.. rubric:: Attributes Documentation
.. autoattribute:: DIRECTORY
.. autoattribute:: FILE
.. autoattribute:: FILE_OR_DIRECTORY
.. rubric:: Methods Documentation
.. automethod:: detach
.. automethod:: fileType
.. automethod:: hasSuffix
.. automethod:: isDir
.. automethod:: isFile
.. automethod:: moveTo
.. automethod:: name
.. automethod:: parent
.. automethod:: path
.. automethod:: pathFrom
.. automethod:: suffix
_sources/api/mobase.GameFeature.rst.txt
-7
View File
@@ -1,7 +0,0 @@
GameFeature
===========
.. currentmodule:: mobase
.. autoclass:: GameFeature
:show-inheritance:
_sources/api/mobase.GamePlugins.rst.txt
-25
View File
@@ -1,25 +0,0 @@
GamePlugins
===========
.. currentmodule:: mobase
.. autoclass:: GamePlugins
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~GamePlugins.getLoadOrder
~GamePlugins.lightPluginsAreSupported
~GamePlugins.mediumPluginsAreSupported
~GamePlugins.readPluginLists
~GamePlugins.writePluginLists
.. rubric:: Methods Documentation
.. automethod:: getLoadOrder
.. automethod:: lightPluginsAreSupported
.. automethod:: mediumPluginsAreSupported
.. automethod:: readPluginLists
.. automethod:: writePluginLists
_sources/api/mobase.GuessQuality.rst.txt
-31
View File
@@ -1,31 +0,0 @@
GuessQuality
============
.. currentmodule:: mobase
.. autoclass:: GuessQuality
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~GuessQuality.FALLBACK
~GuessQuality.GOOD
~GuessQuality.INVALID
~GuessQuality.META
~GuessQuality.PRESET
~GuessQuality.USER
~GuessQuality.name
~GuessQuality.value
.. rubric:: Attributes Documentation
.. autoattribute:: FALLBACK
.. autoattribute:: GOOD
.. autoattribute:: INVALID
.. autoattribute:: META
.. autoattribute:: PRESET
.. autoattribute:: USER
.. autoattribute:: name
.. autoattribute:: value
_sources/api/mobase.GuessedString.rst.txt
-23
View File
@@ -1,23 +0,0 @@
GuessedString
=============
.. currentmodule:: mobase
.. autoclass:: GuessedString
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~GuessedString.reset
~GuessedString.setFilter
~GuessedString.update
~GuessedString.variants
.. rubric:: Methods Documentation
.. automethod:: reset
.. automethod:: setFilter
.. automethod:: update
.. automethod:: variants
_sources/api/mobase.IDownloadManager.rst.txt
-29
View File
@@ -1,29 +0,0 @@
IDownloadManager
================
.. currentmodule:: mobase
.. autoclass:: IDownloadManager
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~IDownloadManager.downloadPath
~IDownloadManager.onDownloadComplete
~IDownloadManager.onDownloadFailed
~IDownloadManager.onDownloadPaused
~IDownloadManager.onDownloadRemoved
~IDownloadManager.startDownloadNexusFile
~IDownloadManager.startDownloadURLs
.. rubric:: Methods Documentation
.. automethod:: downloadPath
.. automethod:: onDownloadComplete
.. automethod:: onDownloadFailed
.. automethod:: onDownloadPaused
.. automethod:: onDownloadRemoved
.. automethod:: startDownloadNexusFile
.. automethod:: startDownloadURLs
_sources/api/mobase.IFileTree.rst.txt
-65
View File
@@ -1,65 +0,0 @@
IFileTree
=========
.. currentmodule:: mobase
.. autoclass:: IFileTree
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~IFileTree.CONTINUE
~IFileTree.FAIL_IF_EXISTS
~IFileTree.MERGE
~IFileTree.REPLACE
~IFileTree.SKIP
~IFileTree.STOP
.. rubric:: Methods Summary
.. autosummary::
~IFileTree.addDirectory
~IFileTree.addFile
~IFileTree.clear
~IFileTree.copy
~IFileTree.createOrphanTree
~IFileTree.exists
~IFileTree.find
~IFileTree.insert
~IFileTree.merge
~IFileTree.move
~IFileTree.pathTo
~IFileTree.remove
~IFileTree.removeAll
~IFileTree.removeIf
~IFileTree.walk
.. rubric:: Attributes Documentation
.. autoattribute:: CONTINUE
.. autoattribute:: FAIL_IF_EXISTS
.. autoattribute:: MERGE
.. autoattribute:: REPLACE
.. autoattribute:: SKIP
.. autoattribute:: STOP
.. rubric:: Methods Documentation
.. automethod:: addDirectory
.. automethod:: addFile
.. automethod:: clear
.. automethod:: copy
.. automethod:: createOrphanTree
.. automethod:: exists
.. automethod:: find
.. automethod:: insert
.. automethod:: merge
.. automethod:: move
.. automethod:: pathTo
.. automethod:: remove
.. automethod:: removeAll
.. automethod:: removeIf
.. automethod:: walk
_sources/api/mobase.IGameFeatures.rst.txt
-23
View File
@@ -1,23 +0,0 @@
IGameFeatures
=============
.. currentmodule:: mobase
.. autoclass:: IGameFeatures
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~IGameFeatures.gameFeature
~IGameFeatures.registerFeature
~IGameFeatures.unregisterFeature
~IGameFeatures.unregisterFeatures
.. rubric:: Methods Documentation
.. automethod:: gameFeature
.. automethod:: registerFeature
.. automethod:: unregisterFeature
.. automethod:: unregisterFeatures
_sources/api/mobase.IInstallationManager.rst.txt
-25
View File
@@ -1,25 +0,0 @@
IInstallationManager
====================
.. currentmodule:: mobase
.. autoclass:: IInstallationManager
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~IInstallationManager.createFile
~IInstallationManager.extractFile
~IInstallationManager.extractFiles
~IInstallationManager.getSupportedExtensions
~IInstallationManager.installArchive
.. rubric:: Methods Documentation
.. automethod:: createFile
.. automethod:: extractFile
.. automethod:: extractFiles
.. automethod:: getSupportedExtensions
.. automethod:: installArchive
_sources/api/mobase.IModInterface.rst.txt
-89
View File
@@ -1,89 +0,0 @@
IModInterface
=============
.. currentmodule:: mobase
.. autoclass:: IModInterface
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~IModInterface.absolutePath
~IModInterface.addCategory
~IModInterface.addNexusCategory
~IModInterface.categories
~IModInterface.clearPluginSettings
~IModInterface.color
~IModInterface.comments
~IModInterface.converted
~IModInterface.endorsedState
~IModInterface.fileTree
~IModInterface.gameName
~IModInterface.ignoredVersion
~IModInterface.installationFile
~IModInterface.isBackup
~IModInterface.isForeign
~IModInterface.isOverwrite
~IModInterface.isSeparator
~IModInterface.name
~IModInterface.newestVersion
~IModInterface.nexusId
~IModInterface.notes
~IModInterface.pluginSetting
~IModInterface.pluginSettings
~IModInterface.primaryCategory
~IModInterface.removeCategory
~IModInterface.repository
~IModInterface.setGameName
~IModInterface.setIsEndorsed
~IModInterface.setNewestVersion
~IModInterface.setNexusID
~IModInterface.setPluginSetting
~IModInterface.setUrl
~IModInterface.setVersion
~IModInterface.trackedState
~IModInterface.url
~IModInterface.validated
~IModInterface.version
.. rubric:: Methods Documentation
.. automethod:: absolutePath
.. automethod:: addCategory
.. automethod:: addNexusCategory
.. automethod:: categories
.. automethod:: clearPluginSettings
.. automethod:: color
.. automethod:: comments
.. automethod:: converted
.. automethod:: endorsedState
.. automethod:: fileTree
.. automethod:: gameName
.. automethod:: ignoredVersion
.. automethod:: installationFile
.. automethod:: isBackup
.. automethod:: isForeign
.. automethod:: isOverwrite
.. automethod:: isSeparator
.. automethod:: name
.. automethod:: newestVersion
.. automethod:: nexusId
.. automethod:: notes
.. automethod:: pluginSetting
.. automethod:: pluginSettings
.. automethod:: primaryCategory
.. automethod:: removeCategory
.. automethod:: repository
.. automethod:: setGameName
.. automethod:: setIsEndorsed
.. automethod:: setNewestVersion
.. automethod:: setNexusID
.. automethod:: setPluginSetting
.. automethod:: setUrl
.. automethod:: setVersion
.. automethod:: trackedState
.. automethod:: url
.. automethod:: validated
.. automethod:: version
_sources/api/mobase.IModList.rst.txt
-43
View File
@@ -1,43 +0,0 @@
IModList
========
.. currentmodule:: mobase
.. autoclass:: IModList
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~IModList.allMods
~IModList.allModsByProfilePriority
~IModList.displayName
~IModList.getMod
~IModList.onModInstalled
~IModList.onModMoved
~IModList.onModRemoved
~IModList.onModStateChanged
~IModList.priority
~IModList.removeMod
~IModList.renameMod
~IModList.setActive
~IModList.setPriority
~IModList.state
.. rubric:: Methods Documentation
.. automethod:: allMods
.. automethod:: allModsByProfilePriority
.. automethod:: displayName
.. automethod:: getMod
.. automethod:: onModInstalled
.. automethod:: onModMoved
.. automethod:: onModRemoved
.. automethod:: onModStateChanged
.. automethod:: priority
.. automethod:: removeMod
.. automethod:: renameMod
.. automethod:: setActive
.. automethod:: setPriority
.. automethod:: state
_sources/api/mobase.IModRepositoryBridge.rst.txt
-51
View File
@@ -1,51 +0,0 @@
IModRepositoryBridge
====================
.. currentmodule:: mobase
.. autoclass:: IModRepositoryBridge
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~IModRepositoryBridge.descriptionAvailable
~IModRepositoryBridge.downloadURLsAvailable
~IModRepositoryBridge.endorsementToggled
~IModRepositoryBridge.endorsementsAvailable
~IModRepositoryBridge.fileInfoAvailable
~IModRepositoryBridge.filesAvailable
~IModRepositoryBridge.requestFailed
~IModRepositoryBridge.trackedModsAvailable
~IModRepositoryBridge.trackingToggled
.. rubric:: Methods Summary
.. autosummary::
~IModRepositoryBridge.requestDescription
~IModRepositoryBridge.requestDownloadURL
~IModRepositoryBridge.requestFileInfo
~IModRepositoryBridge.requestFiles
~IModRepositoryBridge.requestToggleEndorsement
.. rubric:: Attributes Documentation
.. autoattribute:: descriptionAvailable
.. autoattribute:: downloadURLsAvailable
.. autoattribute:: endorsementToggled
.. autoattribute:: endorsementsAvailable
.. autoattribute:: fileInfoAvailable
.. autoattribute:: filesAvailable
.. autoattribute:: requestFailed
.. autoattribute:: trackedModsAvailable
.. autoattribute:: trackingToggled
.. rubric:: Methods Documentation
.. automethod:: requestDescription
.. automethod:: requestDownloadURL
.. automethod:: requestFileInfo
.. automethod:: requestFiles
.. automethod:: requestToggleEndorsement
_sources/api/mobase.IOrganizer.rst.txt
-105
View File
@@ -1,105 +0,0 @@
IOrganizer
==========
.. currentmodule:: mobase
.. autoclass:: IOrganizer
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~IOrganizer.appVersion
~IOrganizer.basePath
~IOrganizer.createMod
~IOrganizer.createNexusBridge
~IOrganizer.downloadManager
~IOrganizer.downloadsPath
~IOrganizer.findFileInfos
~IOrganizer.findFiles
~IOrganizer.gameFeatures
~IOrganizer.getFileOrigins
~IOrganizer.getGame
~IOrganizer.getPluginDataPath
~IOrganizer.installMod
~IOrganizer.isPluginEnabled
~IOrganizer.listDirectories
~IOrganizer.managedGame
~IOrganizer.modDataChanged
~IOrganizer.modList
~IOrganizer.modsPath
~IOrganizer.onAboutToRun
~IOrganizer.onFinishedRun
~IOrganizer.onNextRefresh
~IOrganizer.onPluginDisabled
~IOrganizer.onPluginEnabled
~IOrganizer.onPluginSettingChanged
~IOrganizer.onProfileChanged
~IOrganizer.onProfileCreated
~IOrganizer.onProfileRemoved
~IOrganizer.onProfileRenamed
~IOrganizer.onUserInterfaceInitialized
~IOrganizer.overwritePath
~IOrganizer.persistent
~IOrganizer.pluginDataPath
~IOrganizer.pluginList
~IOrganizer.pluginSetting
~IOrganizer.profile
~IOrganizer.profileName
~IOrganizer.profilePath
~IOrganizer.refresh
~IOrganizer.resolvePath
~IOrganizer.setPersistent
~IOrganizer.setPluginSetting
~IOrganizer.startApplication
~IOrganizer.virtualFileTree
~IOrganizer.waitForApplication
.. rubric:: Methods Documentation
.. automethod:: appVersion
.. automethod:: basePath
.. automethod:: createMod
.. automethod:: createNexusBridge
.. automethod:: downloadManager
.. automethod:: downloadsPath
.. automethod:: findFileInfos
.. automethod:: findFiles
.. automethod:: gameFeatures
.. automethod:: getFileOrigins
.. automethod:: getGame
.. automethod:: getPluginDataPath
.. automethod:: installMod
.. automethod:: isPluginEnabled
.. automethod:: listDirectories
.. automethod:: managedGame
.. automethod:: modDataChanged
.. automethod:: modList
.. automethod:: modsPath
.. automethod:: onAboutToRun
.. automethod:: onFinishedRun
.. automethod:: onNextRefresh
.. automethod:: onPluginDisabled
.. automethod:: onPluginEnabled
.. automethod:: onPluginSettingChanged
.. automethod:: onProfileChanged
.. automethod:: onProfileCreated
.. automethod:: onProfileRemoved
.. automethod:: onProfileRenamed
.. automethod:: onUserInterfaceInitialized
.. automethod:: overwritePath
.. automethod:: persistent
.. automethod:: pluginDataPath
.. automethod:: pluginList
.. automethod:: pluginSetting
.. automethod:: profile
.. automethod:: profileName
.. automethod:: profilePath
.. automethod:: refresh
.. automethod:: resolvePath
.. automethod:: setPersistent
.. automethod:: setPluginSetting
.. automethod:: startApplication
.. automethod:: virtualFileTree
.. automethod:: waitForApplication
_sources/api/mobase.IPlugin.rst.txt
-35
View File
@@ -1,35 +0,0 @@
IPlugin
=======
.. currentmodule:: mobase
.. autoclass:: IPlugin
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~IPlugin.author
~IPlugin.description
~IPlugin.enabledByDefault
~IPlugin.init
~IPlugin.localizedName
~IPlugin.master
~IPlugin.name
~IPlugin.requirements
~IPlugin.settings
~IPlugin.version
.. rubric:: Methods Documentation
.. automethod:: author
.. automethod:: description
.. automethod:: enabledByDefault
.. automethod:: init
.. automethod:: localizedName
.. automethod:: master
.. automethod:: name
.. automethod:: requirements
.. automethod:: settings
.. automethod:: version

Some files were not shown because too many files have changed in this diff Show More