Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin

Terms of Use
Become a Patron
Discuss / Support
Quick InfoVersion: Beta R2
Made for RPG Maker MZ 1.9.0
Advanced[USERS]
Would you like to switch the [CGMZ] Controls Window plugin window mid-scene? If you are using a plugin that accepts custom JavaScript, you can call the below JavaScript to change the window to one set up in the Other Presets parameter:
this.CGMZ_changeControlsWindow("yourIdHere");

If your custom JavaScript is not running within a scene context (or if your game crashes when running the above code and you don't know what a context is), try instead running the following code:
SceneManager._scene.CGMZ_changeControlsWindow("yourIdHere");

If it is still not working, the scene is not coded as a menu scene and the [CGMZ] Controls Window is set up to only work in menu scenes.

[DEVELOPERS]
Would you like to provide an easy way to show the [CGMZ] Controls Window plugin window in your custom scene? Add a text parameter that takes an id, then in your scene implement the function:
Scene_MenuBase.prototype.CGMZ_getControlsWindowOtherPreset
This should return the following:
return $cgmzTemp.getControlWindowPresetOther(yourPresetId);

Now your custom scene will show the [CGMZ] Controls Window with the options the user set up in their Other Presets parameter with that id in this plugin.
Plugin CommandsThis plugin does not have any plugin commands.
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_ControlsWindow.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 option to change the windowskin
  • Added option to change the window tone
  • Added option to make the window transparent or dim
  • Added option to change the window back opacity
  • Added option to change window padding
Version AlphaR3
  • Added option to use alternate height calculation method
  • Added option to draw a background image to the window
  • Added option to report expected back image dimensions to console
Version AlphaR4
  • Added presets for easy other plugin integration
  • Added functions for changing control window mid-scene
Version Beta
  • Added [CGMZ] Window Backgrounds integration
Version BetaR2
  • Added [CGMZ] Window Settings integration

Back to Plugin