Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin

Terms of Use
Become a Patron
Discuss / Support
Quick InfoVersion: Alpha R2
Made for RPG Maker MZ 1.9.0
JavaScriptThe window background will depend on the id you give it, which will first attempt to match the window constructor name. The default window constructor names are:

Window_ActorCommand - The actor command window in battle
Window_BattleActor - Select actor window in battle
Window_BattleEnemy - Select enemy window in battle
Window_BattleLog - Log window in battle
Window_BattleSkill - Select skill window in battle
Window_BattleStatus - Status window in battle
Window_ChoiceList - Show Choice event command window
Window_EquipCommand - Equip command window
Window_EquipItem - Item select window in equip scene
Window_EquipSlot - Slot select window in equip scene
Window_EquipStatus - Status window in the equip scene
Window_EventItem - Select item event command window
Window_GameEnd - Game End command window
Window_Gold - Window that displays gold value (various areas)
Window_Help - Window that displays item info (various areas)
Window_ItemCategory - Select window for item category (item/shop)
Window_ItemList - Select item window in the item scene
Window_MapName - Map name window
Window_MenuActor - Select actor window in item/skill scene
Window_MenuCommand - Menu command window
Window_MenuStatus - Status window in main menu
Window_Message - Show Text event command window
Window_NameBox - Name box window above show text event command
Window_NameEdit - Actor name window on name input
Window_NameInput - Character select window on name input
Window_NumberInput - Input Number event command window
Window_Options - Option select window
Window_PartyCommand - Party command window in battle
Window_SavefileList - Save file select window
Window_ScrollText - Scrolling text event command window
Window_ShopBuy - Item select window during shop buy
Window_ShopCommand - Command window for shop scene
Window_ShopNumber - Number input for shop scene
Window_ShopSell - Item select window during shop sell
Window_ShopStatus - Status window in shop scene
Window_SkillList - Skill select in skill scene
Window_SkillStatus - Status window in skill scene
Window_SkillType - Skill type select window in skill scene
Window_Status - Full status window in status scene
Window_StatusEquip - Equipment window in status scene
Window_StatusParams - Parameter window in status scene
Window_TitleCommand - Command window in title scene

This plugin will work for all windows, or at least those that are based on the core Window object from the default code (which should be all windows).

Keep in mind that plugins could change the above windows to something else, so if you are using a plugin that changes a lot about a certain scene and the above constructors for that scene are not working, you may be dealing with a custom window and would need to ask the plugin author for the window constructor name.
PresetsPresets use the same parameter as normal backgrounds, but are not loaded during window creation. Instead, the window can change to that preset sometime after window creation. This is mostly for custom js or other plugins to integrate with this one. Presets cannot use the id "default" as this is a reserved id.

For plugin users: When setting up an integration with this plugin, use the id in the preset parameter as the id of the background.

For plugin creators: When setting up an integration with this plugin, use the following code to switch the window background to one from this plugin:

this.CGMZ_setWindowBackground("id");

This can be called from any window that inherits from Window. To reset to the default background, use "default" as the id. This is also how you would change window background in custom js code as a plugin user.
Scrolling BackgroundsYou can make your backgrounds scroll, similar to how map parallax images can scroll. To scroll faster, reduce the scroll frames or increase the scroll X/Y (further from 0). To scroll slower, increase the scroll frames or reduce the scroll X/Y (closer to 0).
TintingYou can add tints to backgrounds. These use hexadecimal numbers to provide a tint. You can find a color picker online, such as:

https://www.w3schools.com/colors/colors_picker.asp

From here, you would select a color and then copy the one that is in the format: #ff0000 Remove the # when you paste it into the tint parameter, and now your custom background will be tinted in that color.
Error ReportingThis plugin reports common errors with parameter setup. If it doesn't seem to be working, please open the dev tools by pressing F8 during a playtest, and then selecting the CONSOLE tab at the top of the window that opens. Look for any warning logs which come from CGMZ_WindowBackgrounds.
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_WindowBackgrounds.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 image tints
  • Added option to report dimension to console

Back to Plugin