Documentation
Quick InfoVersion: 1.31.0
Made for RPG Maker MZ 1.9.0
Checking For UpdatesThis plugin can automatically check if any CGMZ plugin you have is out of date. To see out of date plugins, open the console while playtesting by pressing F8.
To enable this, turn Check for Updates parameter to true. The game will *NOT* check for updates in deployed games, even if this parameter is true.
Plugin CommandsThis plugin supports the following plugin commands:
Initialize - Re-initializes the CGMZ Core. Only use this if you know what you are doing! Erases CGMZ data.
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_Core.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.1
- Added function to automatically check if any CGMZ plugin is out of date
- Added function to split a string into multiple lines if the string is too long for a window to handle without reducing font size (text wrap)
- Added class CGMZ_Window_Scrollable which can scroll vertically with handlers but no visible cursor. A mix between Window_Base, Window_Scrollable, and Window_Selectable
- Added CGMZ map name meta access
- Removed unused code for a title window as this no longer fits with MZ touch buttons
- Added draw gauge functionality to windows that do not need sprite gauges
- Updated api call for version check to use semantic versioning
- Added link to update directly from console
- Cut down on outdated CGMZ plugin warnings in console
- Added basic input processing for all keys on keyboard
- Added option to open dev tools on game start
- Added option to show fps on game start
- Added option to go fullscreen on game start
- Bugfix to add cap to scrollable window size
- Added new draw text function for text codes with automatic line breaks
- Added update behavior
- Added behavior after load in CGMZ classes
- Added new timer class
- Optimized existing code
- Added parameter to simulate deployed environment during playtest
- Added new draw text function for drawing for a single line of text with text codes
- More concise error reporting
- Bugfix for font size changes throwing off line wrap when drawing text with text codes
- Added function for getting file info
- Removed deprecated code (if getting crash after update, update crashing plugin)
- Added support for subfolders for images
- Added more customizable selectable window with categories
- Added function to draw a divider on windows
- Added support for spritesheet animations on map
- Various bug fixes for text code drawing in unusual cases
- Added horizontally scrolling windows
- Added filesystem functions
- Changed some CGMZ draw text functions to adjust width of text if too wide
- Documentation should no longer horizontally scroll
- Added gamepad meta info detection
- Added idle detection
- Added CGMZ_Utils to replace some CGMZ_Temp utility functions
- Added JSON parse helper function to better report errors
- Added functions to help change data after saved game loaded
- Fixed bug with centered text drawing when scaled into a small area with an offset
- Out of date plugin checker should now only check once at boot
- Documentation updated
- Add gamepad release function
- Add Spanish language support
- Bug fix for scaled left-align text drawing
- Added utility function for easier compare of numbers
- Added utility function to draw background rectangle
- Added utility function to draw input styles for checkbox, radio, and toggle switch
- Added utility function to draw N-gons
- Added utility function for opening URLs
- Fix outdated plugin message for alpha/beta plugins
- Expanded function for getting item data objects to include skill/states
- Added locale options
- Moved date functions to CGMZ_Utils from CGMZ_Temp
- Added function to draw step animation on windows
- Added sprite layer above/below windows in menus
- Fix crash when using Event Test
- Added tracking for last input type
- Added function to parse JSON SE parameters
- Added function to draw a gradient filled rect
- Added function to parse JSON Tone parameters
- Added function to setup common toast parameters
- Added selectable window that can show a tilemap
- Added lerp functions
- Fix gradient rect function to clear with contents
- Fix issue with idle timer when many keys pressed at same time
- Removed deprecated $cgmzTemp.timeSplit
- Add common CGMZ window options to window classes
- Add report dimensions utility function
- Bug fix for some numbers not taking locale into account
- Bug fix for toast parser crash when toast object was undefined
- Bug fix for some rare cases where gamepad input could crash game
- Bug fix for CGMZ Selectable Window not tracking top row properly
- Added window class to get various window parts as bitmaps
- Added animated regions to windows
- Added more customizable gauge class
- Added tracking for last used gamepad index
- Added more options to header function, and text code support
- Added easier lookup for actor/class/map/event/enemy/troop data
- Fixed bug with scrolling height calculations when padding was changed
- Added utility function to check for any truthy values on an object
- Added utility function for performing some math operations
- Added utility function for reading meta parameters
- Added function to get distance between characters
- Added function to draw sv actor sprite
- Added function for basic event comment parsing
- Added function to get the last gamepad that had input
- Added function to parse toast parameters easier
- Fixed toast common property tone parsing
- Added function to load a face image before drawing it
- Added functions for drawing selectable/command backgrounds
- Added function to get random number within a range
- Added utility function to calculate the average level of battle actors
- Added utility function to get sprite bitmap after effects applied
- Fix bug with time to string function
- Added utility function to parse rumble JSON
- Scrollable windows can now always be scrolled with right gamepad stick
- Removed CGMZ_Temp number split function
- Added function to calculate mixed select/standard window height
- Fix bug with horizontal scrolling [CGMZ] Windows with unique padding
- Removed deprecated CGMZ_Temp functions
- Added defaults for scrolling windows
- Added utility function to parse new map parameter type
- Added keyboard scroll keys
- Mouse wheel can now always scroll scrollable windows if cursor over window
- Text drawing functions now have better error handling
- Removed deprecated temp function
- Added hotkeys for menu scenes
- Added TTS parser function
- URL opening now has option to try popup first instead of new tab
- Added a CGMZ Video class for video functionality
- Removed deprecated cgmz temp functions
- Added battle wait functions
- Improved scrolling window default handling
- Fix bug with drawing \n text code in some cases
- Fix bug with \n text code and \n[x] text code handling.
- Added sprite object for displaying animated walk sprite
- Added sprite object for displaying animated battler sprite
- Added Select Window index tracking
- Added title window class
- Added gamepad listeners
- Added window background type tracking
- Added previous map id tracking