Documentation
Quick InfoVersion: Beta R7
Made for RPG Maker MZ 1.9.0
Battle Result VariablesThe battle result variable will change based on win or loss/escape.
- In the case of a win, the variable will be set to 0.
- In the case of an escape, the variable will be set to 1.
- In the case of a loss, the variable will be set to 2.
Integrations[CGMZ] Menu Command Window
You can use this plugin to easily add the Colosseum scene to the main menu. To do so, use the following JavaScript command parameter:
SceneManager.push(CGMZ_Scene_Colosseum);
Additionally, you can include the following line after the above to include only certain fight types:
SceneManager.prepareNextScene(["Type 1","Type 2","etc"]);
[CGMZ] Currency System
You can award custom currencies set up through this plugin as a reward for winning a fight in the colosseum.
[CGMZ] Scene Backgrounds
This plugin will handle the [CGMZ] Colosseum scene background. It has a lot more options than just a static image, including scrolling backgrounds and more.
[CGMZ] Controls Window
This plugin can add a window that shows the player controls within the scene. It supports icons and can even change text based on the player's last input, so if they are using a gamepad you can show them xbox buttons as controls while if they are using a keyboard you can show them keyboard controls.
[CGMZ] Toast Manager
Show a toast window when a new fight is discovered or unlocked. A safeguard is built in so that these toasts only display when the status changes from undiscovered / locked to discovered / unlocked, so you do not need to worry about using the plugin command multiple times.
Plugin CommandsThis plugin supports the following plugin commands:
Call Scene - This calls the colosseum scene. You can optionally pass an array of fight types to include. Fights not of those types will not display.
Discover Troop - This will mark the provided troop as discovered.
Unlock Troop - This will set the provided troop as unlocked.
Is Troop Defeated - This will set the provided switch to TRUE if the provided troop ID has been defeated in the colosseum, else it will be set to FALSE.
Get Fight Data - This will set the provided variable to the amount of wins, losses, or escapes the player has had against the given troop in the colosseum.
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: You cannot modify fight discover, unlock, or won state in saved games. Use plugin commands instead for that.
✓ Remove the plugin with no issue to save data.
Filename
The filename for this plugin MUST remain CGMZ_Colosseum.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 BetaR3
- Added the option to discover fights automatically after winning a battle
- Fixed a brief flash of the colosseum scene if exiting after battle
- Added display info parameter for drag and drop control over display window
- Added options to change windowskin, padding, and back opacity
- Fixed bug with colosseum scene type being forgotten after battle
- Fixed bug where rewards would try to display even when there were none
- Added option to reward certain things only for the first win
- Added [CGMZ] Currency System integration
- Added [CGMZ] Scene Backgrounds integration
- Added [CGMZ] Controls Window integration
- Added New Marker Text for troops the player hasn't fought yet
- Added window tone options
- Added chance for rewards
- Added required levels for fights
- Added option to show battle back in display window
- Added custom space display option
- Added [CGMZ] Window Backgrounds integration
- Added [CGMZ] Window Settings integration
- Display window now more responsive to font size changes
- Fix bug with display window scroll when using custom padding values
- Added win / lose / escape count for fights
- Added custom headers for display window
- Added custom text lines for display window
- Added plugin command to get win / lose / escape count stat
- Added [CGMZ] Toast Manager integration for unlock / discover
- Battle backs set up for the fight will now be used in battle