Documentation
Quick InfoVersion: Alpha R3
Made for RPG Maker MZ 1.9.0
Main FeaturesITEM POPUP
Show an item window with information about an item the first time the player obtains an item. Subsequent times the player obtains the item, the window will no longer display automatically. You have complete control over this window and scene.
Temporarily DisableYou can use the Popup Display Switch or Popup Queue Switch to temporarily disable item popups from occurring, such as if you don't want them to show during a cutscene.
The Display Switch controls if the window can display, but does not prevent windows from queueing and waiting for their turn to display. This can lead to a build up of item popup windows that will all display once the switch is turned back on.
The Popup Queue Switch controls if popups can queue for their turn to display. This prevents them from displaying as they will not be added to the queue. This also prevents them from being queued so when you turn the switch back ON, there will not be potentially a lot of popups at once.
Integrations[CGMZ] Scene Backgrounds
This plugin will allow you to show a custom background image in the item popup scene, including scrolling backgrounds.
[CGMZ] Controls Window
This plugin will allow you to show controls during the Item Popup window. It will display keyboard or gamepad controls, depending on the player's last input.
[CGMZ] Window Backgrounds
Allows you to add an background image to any window, including the item popup window via the no-code preset id system.
[CGMZ] Window Settings
Allows you to change any window's windowskin, style, tone, and more. This includes the item popup window via the no-code preset id system.
Plugin CommandsThis plugin supports the following plugin commands:
Show Popup - Shows the item popup for the given item
Forget Item - Forgets that the item has already been obtained, so the popup can show again
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_ItemPopup.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 custom images for items/weapons/armors instead of icon only
- Added minimum display frame option before input enabled
- Added Ok input to exit scene option
- Fixed a bug that could cause an item to queue multiple times
- Fixed a bug that could cause item popup to show when losing items
- Fixed crash when trying to show item popup for invalid item
- Added custom space for item popup display
- Added open animation for item popup window
- Added [CGMZ] Window Settings integration
- Added [CGMZ] Window Backgrounds integration
- Convert Display and Queue mechanics to game switches