Documentation
Quick InfoVersion: Alpha R2
Made for RPG Maker MZ 1.9.0
Main FeaturesITEM TYPES
You can have more than just items, weapons, armors, and key items with this plugin. Create your own item categories such as ingredients for [CGMZ] crafting or other plugins.
Minor FeaturesITEM SELECT
The event command Select Item allows your player to select an item and store the item id selected into a variable for use in your eventing. This event command is only compatible with regular item categories, such as items, key items, hidden items, etc. This plugin adds the plugin command Select Item to allow you to select an item from a category you have set up. It works the same way as the built in event command, just via plugin command.
SetupTo start with, you need to create your categories. If you are not using Keep Originals, you can also re-create item/weapon/armor/key item by putting item/weapon/armor/keyItem as the category symbol.
Once your categories are created in the plugin parameters, make note of the "symbol" parameter you typed for your category. This can be anything (case sensitive, should not include spaces or commas) and is what is used to separate the items shown in each category.
Once you have the symbol you want an item to belong to, go to that item's page in the Database and enter in the notetag:
<cgmzitemcat:yourCategoryHere>
For example, if your category had a symbol of "metals" you would put:
<cgmzitemcat:metals>
You can assign the same item to multiple categories. To do so, separate the category symbols in the notetag by a comma. For example, if you wanted an item in BOTH the "metals" AND "ingredients" categories, you could put:
<cgmzitemcat:ingredients,metals>
Default CategoriesDefault categories behave a bit differently as they will still contain a list of ALL items, weapons, etc. This means your metal bar would appear in both your metals category and the default item category even without the notetag to tell it to be in the item category. You can prevent this by turning the Hide In Other Categories parameter to true.
SymbolsYOU MUST SET UP YOUR CATEGORY'S SYMBOL PARAMETER. The symbol should be:
1) UNIQUE (not the same as any other category's symbol)
2) NOT EMPTY (you cannot leave it blank)
3) NOT contain spaces or commas
If it helps, you can think of the symbol as the id of the category. It is case-sensitive.
If you want to re-create the default categories and have Keep Originals set to false, you can use the following symbols in your category:
item - Will function as the default item category
weapon - Will function as the default weapon category
armor - Will function as the default armor category
keyItem - Will function as the default key item category
You should also avoid these default symbols for any custom categories.
Plugin CommandsThis plugin supports the following plugin commands:
Select Item - This plugin command functions similar to the Select Item event command, but instead of selecting an item of a built in type it allows you to select an item from a category you have set up.
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_ItemCategories.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 AlphaR2
- Added show js conditions for categories
- Added enable js conditions for categories
- Fixed bug with background image not working for some default entries