Documentation
Quick InfoVersion: 1.5.0
Made for RPG Maker MZ 1.9.0
Command SymbolThe command symbol should be unique and not blank for every command. This symbol is how the plugin knows internally which JS code to run.
Some Command Symbols can have special meanings, mainly when they represent the original 8 commands. The following symbols represent the original 8 commands (case sensitive):
item - Will handle like the original item command
skill - Will handle like the original skill command
equip - Will handle like the original equip command
status - Will handle like the original status command
formation - Will handle like the original formation command
options - Will handle like the original options command
save - Will handle like the original save command
gameEnd - will handle like the original game end command
It is important that you do not use these strings as the Command Symbol property unless you mean to refer to the original commands.
Keep original CommandsIf you set the parameter "Keep Original Commands" to true, the 8 original commands will be untouched and custom commands will go where the makers of RPG Maker MZ intended them to go in the list of menu items. This is the beginner-friendly option.
If you set the parameter "Keep Original Commands" to false, no commands will be added by default and you will need to add any menu item you wish to use even if it is one of the ones that come with the maker (such as the Item command). However, with this option you have more control over where in the list each entry appears and you can also easily hide or disable menu entries with the switches associated with them.
Default CommandsBelow you can find the default 8 commands which you can copy+paste into the text part of the parameter setup if using this option. You can still change the order, the command name, and modify switches to enable/disable and hide/show the option.
Item command:
{"Command Name":"Item","Icon":"0","Command Symbol":"item","JS Command":"","JS Show Condition":"return true;","JS Enable Condition":"return true;","Enable Switch":"0","Show Switch":"0","Subcategory":"","Required Item":"0","Actor Select":"false","Background Image":"","Background Image X":"0","Background Image Y":"0"}
Skill command:
{"Command Name":"Skill","Icon":"0","Command Symbol":"skill","JS Command":"","JS Show Condition":"return true;","JS Enable Condition":"return true;","Enable Switch":"0","Show Switch":"0","Subcategory":"","Required Item":"0","Actor Select":"false","Background Image":"","Background Image X":"0","Background Image Y":"0"}
Equip command:
{"Command Name":"Equip","Icon":"0","Command Symbol":"equip","JS Command":"","JS Show Condition":"return true;","JS Enable Condition":"return true;","Enable Switch":"0","Show Switch":"0","Subcategory":"","Required Item":"0","Actor Select":"false","Background Image":"","Background Image X":"0","Background Image Y":"0"}
Status command:
{"Command Name":"Status","Icon":"0","Command Symbol":"status","JS Command":"","JS Show Condition":"return true;","JS Enable Condition":"return true;","Enable Switch":"0","Show Switch":"0","Subcategory":"","Required Item":"0","Actor Select":"false","Background Image":"","Background Image X":"0","Background Image Y":"0"}
Formation command:
{"Command Name":"Formation","Icon":"0","Command Symbol":"formation","JS Command":"","JS Show Condition":"return true;","JS Enable Condition":"return true;","Enable Switch":"0","Show Switch":"0","Subcategory":"","Required Item":"0","Actor Select":"false","Background Image":"","Background Image X":"0","Background Image Y":"0"}
Options command:
{"Command Name":"Options","Icon":"0","Command Symbol":"options","JS Command":"","JS Show Condition":"return true;","JS Enable Condition":"return true;","Enable Switch":"0","Show Switch":"0","Subcategory":"","Required Item":"0","Actor Select":"false","Background Image":"","Background Image X":"0","Background Image Y":"0"}
Save command:
{"Command Name":"Save","Icon":"0","Command Symbol":"save","JS Command":"","JS Show Condition":"return true;","JS Enable Condition":"return true;","Enable Switch":"0","Show Switch":"0","Subcategory":"","Required Item":"0","Actor Select":"false","Background Image":"","Background Image X":"0","Background Image Y":"0"}
Game End command:
{"Command Name":"Game End","Icon":"0","Command Symbol":"gameEnd","JS Command":"","JS Show Condition":"return true;","JS Enable Condition":"return true;","Enable Switch":"0","Show Switch":"0","Subcategory":"","Required Item":"0","Actor Select":"false","Background Image":"","Background Image X":"0","Background Image Y":"0"}
SubcategoriesSubcategories work by assigning a subcategory to a command. You can have as many commands in one subcategory as you want. These commands will only display when that subcategory is active, assuming they meet other display criteria such as the Show Switch.
To have a command that activates that subcategory, use the following code in the JS Command parameter: this.CGMZ_pushCategory("mySubcategory");
For example, if you had a subcategory named Collectibles, to show the commands associated with that subcategory you would make a command with a JS Command parameter set to:
this.CGMZ_pushCategory("Collectibles");
By default, commands with no subcategory will display in the menu.
FAQQ: I made multiple commands, but they all do the same thing when selected?
A: Your command symbol is either the same for all of them, or you left the command symbol blank.
Plugin CommandsThis plugin does not have any plugin commands.
Saved GamesThis plugin is fully compatible with saved games. This means you can:
✓ Add this plugin to a saved game and it will work as expected.
✓ Change any plugin params and changes will be reflected in saved games.
✓ Remove the plugin with no issue to save data.
Filename
The filename for this plugin MUST remain CGMZ_MenuCommandWindow.js. This is what it comes as when downloaded. The filename is used to load parameters and execute plugin commands. If you change it, things will begin behaving incorrectly and your game will probably crash. Please do not rename the js file.
Known Issues
This plugin currently has no known issues that need to be fixed. If you believe you have encountered a bug, please report it to Casper Gaming.
Compatibility
This plugin currently has no known compatibility issues with other RMMZ plugins. If you believe you have encountered a conflict, please report it to Casper Gaming.
Version HistoryVersion 1.0.1
- Added ability to choose alignment of command text
- Added option to use text codes in commands
- Added option to disable commands if party doesn't have item
- Added Spanish language help documentation
- This plugin now warns instead of crashes when detecting invalid JSON
- Added option to have subcategories with their own list of commands
- Added commands that can require actor selection first
- Added separate Icon property to commands which can be aligned separately
- Added background image option to commands
- Removed option to disable text codes
- This plugin will now attempt to make a command symbol for you if blank
- Added JS Show option for javascript show conditions
- Added JS Enable option for javascript enable conditions
- JS Command type change
- Added easy way to make a command run a common event
- Removed deprecated [CGMZ] Core function calls
- Added on select parameter options for command name, icon, image