mirror of
https://github.com/ModOrganizer2/python-plugins-doc.git
synced 2026-07-27 14:07:44 -07:00
Deploying to master from @ 6e9912d1ef483ea6a0c58c4e5cea03720a47af61 🚀
This commit is contained in:
Holt59
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 19 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.0 KiB |
@@ -0,0 +1,21 @@
|
||||
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
|
||||
@@ -0,0 +1,23 @@
|
||||
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
|
||||
@@ -0,0 +1,27 @@
|
||||
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
|
||||
@@ -0,0 +1,37 @@
|
||||
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
|
||||
@@ -0,0 +1,21 @@
|
||||
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
|
||||
@@ -0,0 +1,51 @@
|
||||
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
|
||||
@@ -0,0 +1,23 @@
|
||||
GamePlugins
|
||||
===========
|
||||
|
||||
.. currentmodule:: mobase
|
||||
|
||||
.. autoclass:: GamePlugins
|
||||
:show-inheritance:
|
||||
|
||||
.. rubric:: Methods Summary
|
||||
|
||||
.. autosummary::
|
||||
|
||||
~GamePlugins.getLoadOrder
|
||||
~GamePlugins.lightPluginsAreSupported
|
||||
~GamePlugins.readPluginLists
|
||||
~GamePlugins.writePluginLists
|
||||
|
||||
.. rubric:: Methods Documentation
|
||||
|
||||
.. automethod:: getLoadOrder
|
||||
.. automethod:: lightPluginsAreSupported
|
||||
.. automethod:: readPluginLists
|
||||
.. automethod:: writePluginLists
|
||||
@@ -0,0 +1,27 @@
|
||||
GuessQuality
|
||||
============
|
||||
|
||||
.. currentmodule:: mobase
|
||||
|
||||
.. autoclass:: GuessQuality
|
||||
:show-inheritance:
|
||||
|
||||
.. rubric:: Attributes Summary
|
||||
|
||||
.. autosummary::
|
||||
|
||||
~GuessQuality.FALLBACK
|
||||
~GuessQuality.GOOD
|
||||
~GuessQuality.INVALID
|
||||
~GuessQuality.META
|
||||
~GuessQuality.PRESET
|
||||
~GuessQuality.USER
|
||||
|
||||
.. rubric:: Attributes Documentation
|
||||
|
||||
.. autoattribute:: FALLBACK
|
||||
.. autoattribute:: GOOD
|
||||
.. autoattribute:: INVALID
|
||||
.. autoattribute:: META
|
||||
.. autoattribute:: PRESET
|
||||
.. autoattribute:: USER
|
||||
@@ -0,0 +1,23 @@
|
||||
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
|
||||
@@ -0,0 +1,37 @@
|
||||
IDownloadManager
|
||||
================
|
||||
|
||||
.. currentmodule:: mobase
|
||||
|
||||
.. autoclass:: IDownloadManager
|
||||
:show-inheritance:
|
||||
|
||||
.. rubric:: Attributes Summary
|
||||
|
||||
.. autosummary::
|
||||
|
||||
~IDownloadManager.downloadComplete
|
||||
~IDownloadManager.downloadFailed
|
||||
~IDownloadManager.downloadPaused
|
||||
~IDownloadManager.downloadRemoved
|
||||
|
||||
.. rubric:: Methods Summary
|
||||
|
||||
.. autosummary::
|
||||
|
||||
~IDownloadManager.downloadPath
|
||||
~IDownloadManager.startDownloadNexusFile
|
||||
~IDownloadManager.startDownloadURLs
|
||||
|
||||
.. rubric:: Attributes Documentation
|
||||
|
||||
.. autoattribute:: downloadComplete
|
||||
.. autoattribute:: downloadFailed
|
||||
.. autoattribute:: downloadPaused
|
||||
.. autoattribute:: downloadRemoved
|
||||
|
||||
.. rubric:: Methods Documentation
|
||||
|
||||
.. automethod:: downloadPath
|
||||
.. automethod:: startDownloadNexusFile
|
||||
.. automethod:: startDownloadURLs
|
||||
@@ -0,0 +1,65 @@
|
||||
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
|
||||
@@ -0,0 +1,27 @@
|
||||
IInstallationManager
|
||||
====================
|
||||
|
||||
.. currentmodule:: mobase
|
||||
|
||||
.. autoclass:: IInstallationManager
|
||||
:show-inheritance:
|
||||
|
||||
.. rubric:: Methods Summary
|
||||
|
||||
.. autosummary::
|
||||
|
||||
~IInstallationManager.createFile
|
||||
~IInstallationManager.extractFile
|
||||
~IInstallationManager.extractFiles
|
||||
~IInstallationManager.getSupportedExtensions
|
||||
~IInstallationManager.installArchive
|
||||
~IInstallationManager.setURL
|
||||
|
||||
.. rubric:: Methods Documentation
|
||||
|
||||
.. automethod:: createFile
|
||||
.. automethod:: extractFile
|
||||
.. automethod:: extractFiles
|
||||
.. automethod:: getSupportedExtensions
|
||||
.. automethod:: installArchive
|
||||
.. automethod:: setURL
|
||||
@@ -0,0 +1,41 @@
|
||||
IModInterface
|
||||
=============
|
||||
|
||||
.. currentmodule:: mobase
|
||||
|
||||
.. autoclass:: IModInterface
|
||||
:show-inheritance:
|
||||
|
||||
.. rubric:: Methods Summary
|
||||
|
||||
.. autosummary::
|
||||
|
||||
~IModInterface.absolutePath
|
||||
~IModInterface.addCategory
|
||||
~IModInterface.addNexusCategory
|
||||
~IModInterface.categories
|
||||
~IModInterface.name
|
||||
~IModInterface.remove
|
||||
~IModInterface.removeCategory
|
||||
~IModInterface.setGameName
|
||||
~IModInterface.setIsEndorsed
|
||||
~IModInterface.setName
|
||||
~IModInterface.setNewestVersion
|
||||
~IModInterface.setNexusID
|
||||
~IModInterface.setVersion
|
||||
|
||||
.. rubric:: Methods Documentation
|
||||
|
||||
.. automethod:: absolutePath
|
||||
.. automethod:: addCategory
|
||||
.. automethod:: addNexusCategory
|
||||
.. automethod:: categories
|
||||
.. automethod:: name
|
||||
.. automethod:: remove
|
||||
.. automethod:: removeCategory
|
||||
.. automethod:: setGameName
|
||||
.. automethod:: setIsEndorsed
|
||||
.. automethod:: setName
|
||||
.. automethod:: setNewestVersion
|
||||
.. automethod:: setNexusID
|
||||
.. automethod:: setVersion
|
||||
@@ -0,0 +1,31 @@
|
||||
IModList
|
||||
========
|
||||
|
||||
.. currentmodule:: mobase
|
||||
|
||||
.. autoclass:: IModList
|
||||
:show-inheritance:
|
||||
|
||||
.. rubric:: Methods Summary
|
||||
|
||||
.. autosummary::
|
||||
|
||||
~IModList.allMods
|
||||
~IModList.displayName
|
||||
~IModList.onModMoved
|
||||
~IModList.onModStateChanged
|
||||
~IModList.priority
|
||||
~IModList.setActive
|
||||
~IModList.setPriority
|
||||
~IModList.state
|
||||
|
||||
.. rubric:: Methods Documentation
|
||||
|
||||
.. automethod:: allMods
|
||||
.. automethod:: displayName
|
||||
.. automethod:: onModMoved
|
||||
.. automethod:: onModStateChanged
|
||||
.. automethod:: priority
|
||||
.. automethod:: setActive
|
||||
.. automethod:: setPriority
|
||||
.. automethod:: state
|
||||
@@ -0,0 +1,51 @@
|
||||
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
|
||||
@@ -0,0 +1,93 @@
|
||||
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.getFileOrigins
|
||||
~IOrganizer.getGame
|
||||
~IOrganizer.getMod
|
||||
~IOrganizer.installMod
|
||||
~IOrganizer.listDirectories
|
||||
~IOrganizer.managedGame
|
||||
~IOrganizer.modDataChanged
|
||||
~IOrganizer.modList
|
||||
~IOrganizer.modsPath
|
||||
~IOrganizer.modsSortedByProfilePriority
|
||||
~IOrganizer.onAboutToRun
|
||||
~IOrganizer.onFinishedRun
|
||||
~IOrganizer.onModInstalled
|
||||
~IOrganizer.onPluginSettingChanged
|
||||
~IOrganizer.onProfileChanged
|
||||
~IOrganizer.onUserInterfaceInitialized
|
||||
~IOrganizer.overwritePath
|
||||
~IOrganizer.persistent
|
||||
~IOrganizer.pluginDataPath
|
||||
~IOrganizer.pluginList
|
||||
~IOrganizer.pluginSetting
|
||||
~IOrganizer.profile
|
||||
~IOrganizer.profileName
|
||||
~IOrganizer.profilePath
|
||||
~IOrganizer.refreshModList
|
||||
~IOrganizer.removeMod
|
||||
~IOrganizer.resolvePath
|
||||
~IOrganizer.setPersistent
|
||||
~IOrganizer.setPluginSetting
|
||||
~IOrganizer.startApplication
|
||||
~IOrganizer.waitForApplication
|
||||
|
||||
.. rubric:: Methods Documentation
|
||||
|
||||
.. automethod:: appVersion
|
||||
.. automethod:: basePath
|
||||
.. automethod:: createMod
|
||||
.. automethod:: createNexusBridge
|
||||
.. automethod:: downloadManager
|
||||
.. automethod:: downloadsPath
|
||||
.. automethod:: findFileInfos
|
||||
.. automethod:: findFiles
|
||||
.. automethod:: getFileOrigins
|
||||
.. automethod:: getGame
|
||||
.. automethod:: getMod
|
||||
.. automethod:: installMod
|
||||
.. automethod:: listDirectories
|
||||
.. automethod:: managedGame
|
||||
.. automethod:: modDataChanged
|
||||
.. automethod:: modList
|
||||
.. automethod:: modsPath
|
||||
.. automethod:: modsSortedByProfilePriority
|
||||
.. automethod:: onAboutToRun
|
||||
.. automethod:: onFinishedRun
|
||||
.. automethod:: onModInstalled
|
||||
.. automethod:: onPluginSettingChanged
|
||||
.. automethod:: onProfileChanged
|
||||
.. automethod:: onUserInterfaceInitialized
|
||||
.. automethod:: overwritePath
|
||||
.. automethod:: persistent
|
||||
.. automethod:: pluginDataPath
|
||||
.. automethod:: pluginList
|
||||
.. automethod:: pluginSetting
|
||||
.. automethod:: profile
|
||||
.. automethod:: profileName
|
||||
.. automethod:: profilePath
|
||||
.. automethod:: refreshModList
|
||||
.. automethod:: removeMod
|
||||
.. automethod:: resolvePath
|
||||
.. automethod:: setPersistent
|
||||
.. automethod:: setPluginSetting
|
||||
.. automethod:: startApplication
|
||||
.. automethod:: waitForApplication
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user