Ring Menu - For Rpg Maker MZ

Updated to v1.0.1!

GENERAL

"Ring" is the third release for the Menu Collection for Rpg Maker MZ. This menu is highly inpired to the one you can see in the game "Secret Of Mana". 

FEATURES

• Animated Ring Menu processed directly on Scene_Map;
• Customization of the whole menu animations speed;
• Customization of the opening and closing radius of the menu;
• Chance to edit the scale factor of the selected commands;
• Command list is registered directly from Window_MenuCommand, however only the main symbols are declared (more information below on how adding compatibilities with custom commands)
• Help Window on map. The text descriptions are customizable in plugin parameters.
• Actor Selection directly on map. It's possible to customize the text that appears inside the help window during the actor selection.

• Menu Icons customizable through plugin parameters;
• Party's gauge stats drawn on the bottom of the screen;

PLUGIN PARAMETERS

• Menu Speed -> This is the speed of the whole menu animations;
• Open Radius -> This is the destination radius in pixels when the menu is opened;
• Closed Radius -> This is the destination radius in pixels when the menu is closed;
• Command Scale Factor -> This is the scale size of the command that is equal to the current index (essentially, the command that is currently selected)
• Help Window Descriptions -> Set the descriptions of the menu commands that will appear in the help window. The help string will be assigned through the symbol you will set in the parameter. The %1 will be replaced from the command name.

• Actor Help Window String -> This is the format string that will be rendered in the help window during the actor selection: The %1 will be replaced from the actor name and the %2 from the actor profile.
• Ring Menu Icons -> The icons that will be rendered for each command in the menu. The icon index will be assigned through the symbol you will set in the parameter. 

• Custom Command Symbols and Custom Personal Commands Symbols [ADVANCED] -> These plugin parameters are really important as they allows you to add symbols compatibility with other menu commands that are differents from the defaults. Essentially, it's possible that you add plugins that may add new commands to the menu. However, this ring menu is particular as the system is made directly in Scene_Map instead of Scene_Menu. So, you will need to add the command logic in this commands. Let's make some examples.

Ex. You add a plugin that adds the command "Bestiary" with the symbol "bestiary" for processing Scene_Bestiary. The command will be added automatically to the roster, you will only need to set icons and descriptions through the parameters explained above. About the interaction, inside Custom Command Symbols you can do something like:

if(symbol === "bestiary") {
    SceneManager.push(Scene_Bestiary)
}

Ex. You add a plugin that adds a new stat-like-window for checking some actors' stuff. So, you need probably to combine commands with personal selection. So, you do something like this in Custom Command Symbols:

if(symbol === "newstatscene") {    
    // This way you'll trigger actor selection. 
    this.commandPersonal();
}

Then, after triggering actor selection, you can set inside Custom Personal Commands Symbols:

if(symbol === "newstatscene") {         
    SceneManager.push(Scene_NewStats)
    // From the actor selection, it will be set the current
    // actor.
}

PLUGIN COMPATIBILITY

This plugin should be compatible with VisuStella's core's plugins and It should not give problems with other plugins if they do not affect intensively default RPG MAKER MZ library.

WARNING! This plugin is not compatible with VisuStella Main Menu Core and with other plugins that may add new commands to the command list (those commands needs to be added with the system explained above)

CREDITS

The image used as background is a wallpaper from Secret Of Mana HD.

RPG MAKER VERSION

The plugin is developed on Rpg Maker MZ - Version 1.3.2 and with the related PIXI.js Version 5.2.4. 

This plugin is NOT compatible with RPG MAKER MV.

TERMS OF USE:

• Credits to BlueMoon.
• Avoid to change plugin information, filename and parameters name for the sake of integrity of the code.
• Edits to the code are allowed.
• The plugin can be used for both commercial and non-commercial projects.
• You can't redistribute this plugin as it is or incorporating portion of the code inside another plugin; 

createMenuCommands() {             this._referenceWindow = new Window_MenuCommand(new PIXI.Rectangle(0,0,1,1));             this._referenceWindow.refresh();             for(let i = 0; i < this._referenceWindow._list.length; i++) {                 const comm = this._referenceWindow._list[i]                 this._symbols.push(comm.symbol)                 this._names[comm.symbol] = comm.name                 let sp = new Sprite();                 sp.alpha = this._globalAlpha                 let iconset = ImageManager.loadSystem("iconset");                 iconset.addLoadListener(() => {                     sp.bitmap = iconset;                     sp.anchor.set(0.5)                     const iconIndex = !!_ring_menu_icons[comm.symbol] ? _ring_menu_icons[comm.symbol] : 16;                     const pw = ImageManager.iconWidth;                     const ph = ImageManager.iconHeight;                     const sx = (iconIndex % 16) * pw;                     const sy = Math.floor(iconIndex / 16) * ph;                     sp.setFrame(sx,sy,pw,ph)                 })                 this.addChild(sp)             }             this._angleDistance = this.calculateAngleDistance()         }