Documentation
Quick InfoVersion: 1.6.0
Made for RPG Maker MZ 1.9.0
Plugin CommandsThis plugin supports the following plugin commands:
Control Switch Random - This command will set the provided switch to either ON or OFF randomly.
Control Switch Region ID - This command will set the provided switch to ON or OFF if the given event is in the given region
Control Switch Terrain Tag - This command will set the provided switch to ON or OFF if the given event is in the given terrain tag
Control Switch Coordinates - This command will set the provided switch to ON or OFF if the given event is in the given x, y coordinates
Control Switch Save Access - This command will set the provided switch to ON or OFF if the player has save access
Control Switch Menu Access - This command will set the provided switch to ON or OFF if the player has menu access
Control Switch Formation Access - This command will set the provided switch to ON or OFF if the player has formation access
Control Switch Encounters - This command will set the provided switch to ON or OFF if encounters are enabled
Control Switch Self Switch - This command will set the provided switch to ON or OFF if the given self switch is ON or OFF
Control Self Switch - This command will set the provided self switch to ON or OFF
Control Timer Add - This command will add the given amount of seconds to the timer
Control Timer Subtract - This command will subtract the given amount of seconds from the timer
Call Scene - This command will call the provided scene
Request Autosave - This command will request an autosave (does not guarantee the save succeeds)
Control Variable String - This command will set the provided variable to the provided text
Control Variable Float - This command will set the provided variable to the provided float number
Conditional Branch Variable - This command will check a variable against a provided constant
Select Weapon - Like the select item event command, but for weapons.
Select Armor - Like the select item event command, but for armors.
Select Skill - Like the select item event command, but for skills.
Stop All Sound - Stops all currently playing BGM/BGS/SE/ME.
Erase All Pictures - Erases all currently shown pictures.
Change Battle Lose - Enable or disable gameover when random battle is lost
Get BGM Pos - Get the current BGM position into a variable.
Get BGS Pos - Get the current BGS position into a variable.
Change Option - Change one of the true / false options for the player.
Change Volume Option - Change one of the volume options for the player.
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_PluginCommands.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 1.1.0
- Added plugin command to set variable to text
- Added plugin command to set variable to float (decimal) number
- Added plugin command to check variable against text/decimals constants
- Added plugin command to select weapons
- Added plugin command to select armors
- Added plugin command to select skills
- Added plugin command to allow the player to lose battle without gameover
- Added plugin command to stop all sound (BGM/BGS/ME/SE)
- Added plugin command to erase all pictures
- Added Spanish language help documentation
- Added plugin command to wait within a given range
- Added plugin command to wait for an amount of frames by variable
- Added plugin command to get BGM position
- Added plugin command to get BGS position
- Added plugin command to change boolean options
- Added plugin command to change volume options
- Reorganized plugin commands