Class: PluginManager

DKTools.PluginManager

Plugin manager class

new DKTools.PluginManager ()

Members

DKTools.PluginManager._requirements Object privatestaticreadonly

List of registered requirements

Methods

DKTools.PluginManager._checkRequirements () privatestatic

Checks the requirements for plugins
Version:
  • 10.0.0

DKTools.PluginManager._getMaxVersion (pluginName)String | undefined privatestatic

Name Type Description
pluginName String Plugin name
Returns:
Type Description
String | undefined

DKTools.PluginManager.checkVersion (pluginName, version)Boolean static

Checks the plugin version Returns true if the current version is greater than or equal to the given version
Name Type Description
pluginName String Plugin name
version String Plugin version
Returns:
Type Description
Boolean Current version is greater than or equal to the given version

DKTools.PluginManager.compareVersions (v1, v2)Boolean static

Compares two versions Returns true if the first version greater than the second
Name Type Description
v1 String First version
v2 String Second version
Since:
  • 11.1.0
Returns:
Type Description
Boolean First version greater than the second

DKTools.PluginManager.getVersion (pluginName)String | undefined static

Returns a version of plugin
Name Type Description
pluginName String Plugin name
Version:
  • 10.0.4
Since:
  • 3.1.0
Returns:
Type Description
String | undefined Version of plugin
Example
DKTools.PluginManager.getVersion('DKTools');

DKTools.PluginManager.initialize () static

Checks the requirements for the plugins
Version:
  • 9.2.0

DKTools.PluginManager.isRegistered (pluginName)Boolean static

Returns true if plugin is registered
Name Type Description
pluginName String Name of plugin
Version:
  • 10.0.3
Returns:
Type Description
Boolean Plugin is registered

DKTools.PluginManager.orderAfter (pluginName, orderAfter)Boolean static

Checks if the specified plugin is below the required one Returns true if the specified plugin is below the required one
Name Type Description
pluginName String Specified plugin
orderAfter String Required plugin
Since:
  • 11.1.0
Returns:
Type Description
Boolean Specified plugin is below the required one

DKTools.PluginManager.orderBefore (pluginName, orderAfter)Boolean static

Checks if the specified plugin is higher the required one Returns true if the specified plugin is higher the required one
Name Type Description
pluginName String Specified plugin
orderAfter String Required plugin
Since:
  • 11.1.0
Returns:
Type Description
Boolean Specified plugin is higher the required one

DKTools.PluginManager.requirePlugin (pluginName, data) static

Registers a requirement of minimum version of plugin
Name Type Description
pluginName String Name of plugin
data String | Object Plugin versions or versions (RPG Maker MV and MZ)
Version:
  • 10.0.0
Examples
// Plugin only for RPG Maker MV
DKTools.PluginManager.requirePlugin('DKTools', '10.0.0');
// Plugin for RPG Maker MV and MZ
DKTools.PluginManager.requirePlugin('DKTools', {
    MV: '10.0.0',
    MZ: '1.0.2'
});