Documentation
Quick InfoVersion: 1.2.2
Made for RPG Maker MZ 1.9.0
Required SetupBefore using this plugin, please set up at least one fast travel point.
Point NamesFast Travel Point names must be unique, as they are used as an ID to refer to the fast travel point. This means you cannot have 2 fast travel points with the same name.
CategoriesIf using categories, the category parameter in the Fast Travel point and the category in the Call Scene command must match exactly. For example, if a fast travel point has the category "Ice Land" then to include this point in the scene, the Call Scene command must either be empty or have the category "Ice Land" listed.
Integrations[CGMZ] Menu Command Window
To add Fast Travel to the main menu, use CGMZ Menu Command Window or similar plugin. The JavaScript code to call the scene from the plugin is:
SceneManager.push(CGMZ_Scene_FastTravel);
Plugin CommandsThis plugin supports the following plugin commands:
Call Scene - Opens the Fast Travel Scene. Optionally, provide categories so the scene only displays specific categories of fast travel points
Discover Fast Travel Point - Changes the discovery status of the fast travel point
Enable Fast Travel Point - Enables/Disables a fast travel point
Change Map - Changes the map (and x/y) coordinates of the fast travel point
Change Category - Changes the category of the fast travel point
Reinitialize - Reset all fast travel points to defaults
Toast ManagerIn the toast manager preset, you can use %name to show the fast travel point's name.
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: Modifying or deleting existing fast travel points will not work in saved games. The saved game will act as if the fast travel point has not been modified or deleted.
✓ Remove the plugin with no issue to save data.
Filename
The filename for this plugin MUST remain CGMZ_FastTravel.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 option to disable (but still show) fast travel points. This comes with a plugin command to change the enabled property of a point
- Added option to hide categories if no points for that category are discovered
- Added option to change the list window's width
- Added option to hide the Touch UI space if not using Touch UI
- Added option to show the list window on the right side of screen
- Added option to make fast travel scene windows transparent
- Added option to change default fast travel scene background image
- Added Spanish Language help documentation
- This plugin now warns in the console if your JSON parameters are not set up correctly instead of crashing
- Added option to change order of picture and description windows
- Added option to change description window text lines
- Added [CGMZ] Scene Backgrounds integration
- Added [CGMZ] Controls Window integration
- Sound Effect parameters now allow custom volume, pitch, pan settings
- Order with Toast Manager no longer important
- Fast Travel location parameters now use new 1.9.0 location type
- Added option to prevent cancel in scene
- Added [CGMZ] Window Settings integration
- Added [CGMZ] Window Backgrounds integration
- [CGMZ] Toast Manager integration converted to preset id system