Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin


Quick InfoVersion: Alpha R6
Made for RPG Maker MZ 1.9.0

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_AnimatedBattleBacks

NotetagsYou can use a note tag on the map properties to begin a map using a CGMZ animated battle back. To do so, use the note tag:
<cgmzabb:id>

For example, if your animated battle back had an id of "battleback1" you could do:
<cgmzabb:battleback1>

Plugin CommandsThis plugin supports the following plugin commands:
Set Battle Back - Sets an animated battle back

Clear Battle Back - Clears a set animated battle back

Show Animation - Shows an individual animation by id (if exists)

Hide Animation - Hides an individual animation by id

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_AnimatedBattleBacks.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 opacity setting to animations
  • Added plugin command to show/hide animations mid-battle
  • Added option to have animations start hidden
Version AlphaR3
  • Added opacity flicker to animations
  • Added map note tag to set up animated battle back
  • Added option to change animation anchor
Version AlphaR4
  • Added scrolling parallax battlebacks and various supporting options
Version AlphaR5
  • Added video option for battleback
  • Added option to hide battleback sprite
  • Simplified Plugin Commands
Version AlphaR6
  • Compatibility with other [CGMZ] plugins that have vehicle encounters

Back to Plugin