Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin

Terms of Use
Become a Patron
Discuss / Support
Quick InfoVersion: Alpha R3
Made for RPG Maker MZ 1.9.0
Added DataSome properties this plugin adds to maps, such as icons or safety levels, are meant to be used by other plugins. On its own, this plugin does not do anything with these parameters.

Developers can use these properties by calling:
$gameMap.CGMZ_getUpgradeData().iconIndex;

A full list of properties is:
name - The map name
iconIndex - The map icon
recommendedLevel - The recommended level
safetyRating - The safety rating
dangerRating - The danger rating
commonEvent - The common event

Getting image data is a little different. To get the image url you would instead do:
$gameMap.CGMZ_getUpgradeData().getImage(imageId);

These properties are also likely to be used throughout [CGMZ] plugins in optional integrations with this plugin.

If you would like to use these properties in events without using JS, you can use the below plugin commands to get this data into game variables.
Plugin CommandsThis plugin supports the following plugin commands:
Get Parameter - Allows you to set a game variable to a parameter that was added to map data for use in eventing. For example, you can get the map data's Recommended Level or Safety Rating into a variable.

Get Parameter Current Map - Same as Get Parameter, but will get the data from the current game map instead of letting you specify which map id to pull the data from.
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_MapUpgrade.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 tile size option
Version AlphaR3
  • Added option to disable shadow pen tiles
  • Map id parameters changed to new map parameter type

Back to Plugin