Rpg Maker Developers Group

//=============================================================================
/*:
* @plugindesc v0.01 This plugin enables you to define macros for notetags.
* @author Thyzer
*
* @param Macro Defines
* @desc In which common event are your macros defined?
* @default 1
*
* @help
* ============================================================================
* Introduction
* ============================================================================
*
* Sometimes we want to use a lot of notetags in our notes. Often we need to
* copy and paste the same notes in other noteboxes. With this plugin you may
* define a macro, which will replace a word with your predefined notetags.
* This removes clutter in the notebox and makes it easier changing values when
* you want the same notetags in different places.
*
* ============================================================================
* Defining Macros
* ============================================================================
*
* Use one comment for each define. The define should look like this:
*
* <name>(<parameter1>, <parameter2>) = <anything> <parameter1> <anything> <parameter2> <anything>
*
* Name: The name can contain any letters a-z, A-Z and 0-9.
* - The name is case sensitive (intentional)
*
* Parameters: You can define as much parameters as you want, they are split with a ",".
*
* The result string, can consist of basically anything you want. If the name
* of a parameter occurs it will be replaced by the text you enter when using
* the macro.
*
* Examples:
*
* ESLOTS = <Equip Slot>
* Weapon
* Armor
* Accessory
* Accessory
* </Equip Slot>
*
* DESC(txt) = <Help Description>
* txt
* </Help Description>
*
* ============================================================================
* Using Macros
* ============================================================================
*
* Simply use the name of the macro in any notebox, it will be replaced
* and parameters will be inserted.
*
* Examples:
*
* ESLOTS
* ==>
* <Equip Slot>
* Weapon
* Armor
* Accessory
* Accessory
* </Equip Slot>
*
* DESC(A hunter in the dark.)
* ==>
* <Help Description>
* A hunter in the dark.
* </Help Description>
*
* ============================================================================
* Changelog
* ============================================================================
*
* Version 0.01:
* - Public release for feedback.
*/
//=============================================================================

var Thyzer = Thyzer || {};
Thyzer.Macros = Thyzer.Macros || {};

Thyzer.Macros.params = PluginManager.parameters("THY_Macros");
Thyzer.Macros.define_common_event = Number(Thyzer.Macros.params["Macro Defines"]);
Thyzer.Macros.regex = /([\w]+)(?:\((.+)\))?/g;
Thyzer.Macros.param_split_regex = /[\s]*\,[\s]*/
Thyzer.Macros.define_regex = /([\w]+)(?:\(((?:[\w]+[\,\s]*)*)\))?(?:[\s]+\=[\s]+)([\s\S]+)/;
Thyzer.Macros.defines = null;


Thyzer.Macros.processMacros = function(group) {
for (var n = 1; n < group.length; n++) {
var obj = group[n];
var notedata = obj.note;

for (var j = 0; j < this.defines.length; j++)
{
var macro = Thyzer.Macros.defines[j];
notedata = notedata.replace(this.regex, function replaceFunction(whole, title, params)
{
if (title === macro.title)
{
var repl_str = macro.replace_str;

if (params != null) {
var args = params.split(this.param_split_regex, macro.params.length);
for (var k = 0; k < macro.params.length; k++)
{
repl_str = repl_str.replace(macro.params[k], args[k]);
}
}
return repl_str;
}
return whole;
});
}

obj.note = notedata;
}
};

Thyzer.Macros.getMacros = function() {
var defines = [];

var ce = $dataCommonEvents[this.define_common_event];

for (var i = 0; i < ce.list.length; i++) {
var elem = ce.list;

if (elem.code === 108)
{
var str = elem.parameters[0];

while (ce.list[i+1].code === 408)
{
str = str.concat("\n" + ce.list[1+i++].parameters[0]);
}
var macr = this.getMacro(str);
if (macr != null) {
defines.push(macr);
}
}
}
return defines;
}

Thyzer.Macros.getMacro = function(comment) {
if (comment.match(this.define_regex)) {
var macr_prms = [];

var title = RegExp.$1;
var params = RegExp.$2;
var replace_str = RegExp.$3;

var prms = params.split(this.param_split_regex);
for (var i = 0; i < prms.length; i++) {
macr_prms.push(prms);
}

var macr = {title:title, params:macr_prms, replace_str:replace_str}
return macr;
}
return null;
}


Thyzer.Macros.DataManager_isDatabaseLoaded = DataManager.isDatabaseLoaded;
DataManager.isDatabaseLoaded = function() {
if (!Thyzer.Macros.DataManager_isDatabaseLoaded.call(this)) return false;
Thyzer.Macros.defines = Thyzer.Macros.getMacros();
Thyzer.Macros.processMacros($dataActors);
Thyzer.Macros.processMacros($dataClasses);
Thyzer.Macros.processMacros($dataSkills);
Thyzer.Macros.processMacros($dataItems);
Thyzer.Macros.processMacros($dataWeapons);
Thyzer.Macros.processMacros($dataArmors);
Thyzer.Macros.processMacros($dataEnemies);
Thyzer.Macros.processMacros($dataStates);
Thyzer.Macros.processMacros($dataTilesets);
return true;
};