Documentation
Quick InfoVersion: Alpha R3
Made for RPG Maker MZ 1.9.0
Main FeaturesSCAN SKILL
Designate a skill as a scan skill. When used, this skill will provide some information about the enemy it is used on, such as current hp/mp and any flavor text assigned to the enemy.
Text CodesIn the HP and MP Text parameters, you can use the following text codes:
%chp - Will be replaced by the target's current hp
%mhp - Will be replaced by the target's max hp
%cmp - Will be replaced by the target's current mp
%mmp - Will be replaced by the target's max mp
In the Flavor Texts, you can use the following text codes:
%n - Will split the text into multiple lines
In Experience / Gold text parameters, you can use the following text codes:
%amount - Will be replaced by the exp / gold amount
In the Item Drop Text parameter, you can use the following text codes:
%type - Will be replaced by the drop item's type (weapon, armor, item)
%icon - Will be replaced by the drop item's icon
%name - Will be replaced by the drop item's name
In the Weakness and Element parameters, you can use text code:
%ele - Will be replaced by the element that fits either the weakness or element.
In the [CGMZ] Enemy Upgrade integrations, you can use the following text codes:
%type - In Type, will be replaced by the flavor text with id "scant".
%loc - In Location, will be replaced by the flavor text with id "scanl".
The location can also come from map notetag: <cgmzscanlocation:x> The plugin will first try to use Enemy Upgrade data and if none is detected it will fall back to the notetag.
PerformanceWhen the parameter "Location By Map" is set to true, the game will look through each map's notetags at the start of the game to try and find any scan location notetags to associate with enemies. This could significantly impact game startup time on lower end hardware or web deploys if your game has a lot of maps. In these cases, it is recommended to leave it OFF and set location information via [CGMZ] Enemy Upgrade.
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_Scan.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 scan info parameters for actors and enemies
- Added drop items and exp/gold to potential scan output
- Added new wait option: wait for input
- Added support for new lines in flavor text
- Added [CGMZ] Enemy Upgrade integration
- Added weakness to scan
- Added element to scan