DKTools

Class: ParameterManager

DKTools.ParameterManager

Class of plugin parameters Manages plugin parameters (supports all types of parameters)

new DKTools.ParameterManager (pluginName)

Name Type Description
pluginName String Name of the plugin
Example
const params = new DKTools.ParameterManager('DKTools');

Members

_params Object privatereadonly

_pluginName String privatereadonly

Methods

DKTools.ParameterManager.parse (string)Object | String static

Parse a string (supports escape characters of the RPG Maker 1.5+)
Name Type Description
string String String to parse
Version:
  • 5.0.0
Returns:
Type Description
Object | String Parsed string

change (path, value)

Changes the parameter value
Name Type Description
path Array.<String> Path to parameter
value * New value
Since:
  • 9.2.0

get (parameterName, item, options)* | undefined

Returns a parameter by its name
Name Type Description
parameterName String Name of parameter
item Number | String | Object optional Index (for an array) or property (for an object) or object with properties to find
options Object optional Options for found item
Name Type Description
key String optional Key (property) of item
index Number optional Index of item
Version:
  • 3.0.0
Returns:
Type Description
* | undefined Parameter by its name or undefined

initialize (pluginName)

Initializes the manager
Name Type Description
pluginName String Name of the plugin
Version:
  • 6.0.0

initializeParams ()

Initializes plugin parameters
Version:
  • 6.0.0