Documentation
Quick InfoVersion: Alpha R7
Made for RPG Maker MZ 1.9.0
The BasicsThe scene background will depend on the JavaScript constructor for the scene. In your parameters, you will set up an image for a constructor. You will need to know what the scene constructor is. Below are the defaults:
Scene_Equip
Scene_GameEnd
Scene_Item
Scene_Load
Scene_Menu
Scene_Name
Scene_Options
Scene_Save
Scene_Shop
Scene_Skill
Scene_Status
This plugin will only work for scenes which extend Scene_MenuBase. If it isn't working for your scene, it probably doesn't inherit from Scene_MenuBase.
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).
PresetsPresets use the same parameter as normal backgrounds, but are not loaded during scene creation. Instead, the scene can opt to change to that preset sometime after scene 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 constructor 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 scene background to one from this plugin:
this.CGMZ_changeSceneBackground("id");
This can be called from any scene that inherits from Scene_MenuBase. To reset to the default background, use "default" as the id. This is also how you would change scene background in custom js code as a plugin user.
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_SceneBackgrounds.
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_SceneBackgrounds.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 AlphaR3
- Added tint parameter for backgrounds
- Added opacity parameter for backgrounds
- Optimized background lookup code
- Added background presets
- Added ability to swap background to a preset mid-scene
- Added option to still display the default map below custom image
- Added option to show an unblurred map image as the background
- Added option to show weather in the menu scenes
- Added video backgrounds