Documentation
Quick InfoVersion: Alpha R2
Made for RPG Maker MZ 1.9.0
The BasicsHi all, this plugin is meant to improve the UI for selecting an item. By default, the select item event command is pretty basic, showing a simple item list in the message window area. This plugin improves on that by creating two new windows for an improved selection experience.
Select Window - This is the window that the user will move the cursor around to select an item. You can change what is drawn for each item here, as well as change the columns. This means you can make it a more standard RTP item list with an icon and a name, or you can make it icon only and show multiple icons per row. It is up to you.
Info Window - This is the window that displays more info about the item currently highlighted in the Select Window. You can show the item name, item description, possession count, and more. It can be used to help the player remember what the item they are selecting is.
-- Selection Features --
This plugin expands the selection features, allowing you to not only select items but also other objects. So far, the other objects that are available are weapons and armors, however I have plans to expand this to things like skills, actors, and even custom data types like CGMZ Professions.
-- On Map --
Just like the default item select, this process occurs entirely on the map scene and will continue displaying the message window if the previous event command was Show Text. If you would like the message window to not display, you can add an event command between the plugin command and the previous Show Text event command, such as a wait 1 frame or a comment.
-- Using Selection Result --
When you add your Select Object plugin command, make sure to set the Variable parameter. This is the game variable that will be set to the id of the selected object, or 0 if no item was selected. You can then use this variable in a conditional branch or elsewhere to check what object the player selected with an ease of use similar to the default Select Item event command.
IntegrationsThis plugin includes additional functionality when used alongside the following plugins:
CGMZ Window Settings
Allows you to customize the select and info windows windowskins, tone, style, and more.
CGMZ Window Backgrounds
Allows you to show an image as the select or info windows backgrounds, including an animated scrolling parallax image.
Plugin CommandsThis plugin supports the following plugin commands:
Select Item - Allows the player to select an item with the improved select object ui. It also includes more powerful filtering options than the default event command.
Select Weapon - Allows the player to select a weapon with the improved select object ui and filtering system.
Select Armor - Allows the player to select an armor with the improved select object ui and filtering system.
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_SelectObject.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 various filters for selection objects
- Added separate no object text for weapons / armors
- Split plugin command into separate plugin commands by select type