Documentation
Quick InfoVersion: 1.4.0
Made for RPG Maker MZ 1.9.0
Default DifficultyThe default difficulty must be the name of a difficulty you have set up. If you mistype the name or the difficulty name does not exist it could cause issues.
ImagesUsing default resolution, the image size which fits best is 446px wide. Images will be automatically scaled if they are wider than the window, and images will be automatically centered if they are not as wide as the window.
Rating ParameterThe difficulty's rating parameter is a number meant to represent the difficulty in number form. It is not displayed anywhere. It is used in the Get Difficulty Plugin Command, for use in eventing custom difficulty differences in your game.
Integrations[CGMZ] Menu Command Window
To easily add the Difficulty scene to your game's main menu, you can use CGMZ Menu Command Window with the following JavaScript parameter:
SceneManager.push(CGMZ_Scene_Difficulty);
[CGMZ] Scene Backgrounds
Customize the scene background for the difficulty select scene via this plugin. You will set up your scene background options in the Scene Backgrounds presets, and then type the background id in to use this integration.
[CGMZ] Controls Window
Show a window that tells the player the controls in the difficulty select scene, either keyboard or gamepad depending on their last input. Set up the window in Controls Window, and then type the id into the integration parameter in Difficulty.
Plugin CommandsThis plugin supports the following plugin commands:
Set Difficulty - Sets the difficulty of the game to the given value
Get Difficulty - Stores the difficulty rating of the current difficulty in a variable
Discover Difficulty - Sets the discovered status of the difficulty
Enable Difficulty - Sets the enabled status of the difficulty
Reset Difficulty - Resets the difficulty to the default difficulty
Call Scene - Calls the difficulty select scene
Check Playthrough Difficulty - Stores the hardest or easiest selected difficulty's rating parameter into a variable, for use in your events.
Saved GamesThis plugin is partially compatible with saved games. This means you can:
✓ Add this plugin to a saved game and it will work as expected.
✘ Modifying plugin parameters is not fully supported. The following will not work correctly in previously saved games: The difficulty name cannot be changed for saved games. Saved games will still go by the difficulty's old name.
✓ Remove the plugin with no issue to save data.
Filename
The filename for this plugin MUST remain CGMZ_Difficulty.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
- Bugfix for some percentages displaying incorrectly
- Add option to discover/undiscover difficulties
- Add option to display list window on right
- Add option to change the window padding
- Add Spanish language documentation
- Difficulty select scene now starts with current difficulty selected
- This plugin now warns instead of crashes if your JSON plugin parameters are not set up correctly
- Added enable/disable status to difficulties. Now you can have a discovered difficulty that displays, but is not selectable until enabled
- Added plugin commands to enable/disable a difficulty
- Added the option to have custom lines of information about the difficulty
- Added integration with [CGMZ] Scene Backgrounds
- Added integration with [CGMZ] Controls Window
- Added window tone, skin, back opacity options for each window
- All text should now support text codes
- Window type changed to selectable ui
- Description changed to multiline_string type
- Difficulty window now scrolls if necessary
- Difficulty window should work with font size change text codes
- Fixed bug with list window using difficulty window padding parameter
- Added buy/sell price modifiers
- Added tracking of difficulties selected throughout playthrough
- Added custom space display item
- Added custom header display item
- Added [CGMZ] Window Settings integration
- Added [CGMZ] Window Backgrounds integration
- Added switch for when difficulty is on/off
- Added variable to track current difficulty rating