Documentation
Quick InfoVersion: Beta R4
Made for RPG Maker MZ 1.10.0
REQUIRED: All [CGMZ] Plugins require [CGMZ] Core placed above them in the Plugin Manager.
Quick Start GuideTo get started using this plugin, follow the below steps:
1) If desired, set up automatic rumbles that can occur in the plugin parameters.
2) When you want the gamepad to rumble in your events, use the plugin commands to rumble the controller.
CompatibilityThis plugin will not work for Firefox users on a web deploy. There should be no crashes or anything like that, it simply won't rumble the gamepad in that environment. Once Firefox adds a way to rumble gamepads, this plugin will be updated to work for that browser (or it may just automatically start working if implemented the same way as other browsers).
Plugin CommandsThis plugin supports the following plugin commands:
Rumble All
Will cause all connected gamepads to rumble with the given parameters
Stop All
Will cause all connected gamepads to stop any existing rumbles
Rumble Controller
Will cause a single controller (by index) to rumble with the given parameters
Stop Controller
Will cause a single controller (by index) to stop any existing rumbles
Positional Rumble
Causes all connected gamepads to rumble, with drop off in intensity based on how far away the player is from a location on the map. Note that these only work on the map.
IntegrationsThis plugin has additional functionality when used with the following [CGMZ] plugins:
[CGMZ] Options
With this plugin, you can create a custom option to allow the player to turn rumble functionality on/off themselves. This plugin will check the option symbol cgmz_rumble for true/false (if set). When creating your option you should make sure to assign it the symbol cgmz_rumble and make it a toggle option type.
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_Rumble.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 support for rumble start/stop on individual controller
- Added debug feature to enable logging of errors in playtests
- Added automatic rumble during certain events
- Added switch control over rumble functionality
- Added option to auto-rumble on player transfer
- Removed Log Errors option
- Added option to rumble during animations at specific frames
- Added option to skip switch check
- Added integration with [CGMZ] Options
- Added position based rumbles