Documentation
Quick InfoVersion: Alpha R5
Made for RPG Maker MZ 1.9.0
The BasicsCurrently, this plugin supports the following vehicle types:
Boat - Similar to the default boat. You can create as many of these as you want, and have different speeds, image, audio, or passabilities for them.
Ship - Similar to the default ship. You can create as many of these as you want, and have different speeds, image, audio, or passabilities for them.
Airship - Similar to the default airship. You can create as many of these as you want, and have different speeds, image, audio, or altitudes for them.
Land - A vehicle that can only pass through land tiles. You can also make these pass through otherwise unpassable tiles using regions or tile ids. This can be used to allow the vehicle to pass through mountains or other tiles the player otherwise could not pass through, without allowing it to have complete freedom like the airship. You can have as many of these as you want, and have different speeds, image, audio, and passability for each.
Vehicle SettingsCustom vehicles are created by choosing different setting options. When choosing each vehicle's properties, some properties will make no sense when used together. Please keep this in mind. For example, creating a sea vehicle with no landing offset will lead to problems docking or getting on the vehicle, as the one tile offset is required to land properly for those vehicle types.
DirectionsRPG Maker handles directions using numbers that correspond to either left, right, up, or down. When this plugin asks for a direction, it will be asking for the number that corresponds to the direction you want. The directions are as follows:
2 = down
4 = left
6 = right
8 = up
IntegrationsThis plugin has additional functionality if using the below plugins:
[CGMZ] Vehicle Interiors
Interior settings for custom vehicles requires [CGMZ] Vehicle Interiors to work.
[CGMZ] Vehicle Landing Restrictions
For landing region restrictions, the plugin [CGMZ] Vehicle Landing Restrictions is NOT required, though it will allow you to add some region restrictions for the default 3 vehicles if you are using those.
[CGMZ] Vehicle Encounters
For vehicle encounters, the plugin [CGMZ] Vehicle Encounters is NOT required, though it will allow you to add encounters to the three default vehicles. You must set an enable switch for encounters before you will start encountering enemies in the vehicle.
Plugin CommandsThis plugin supports the following plugin commands:
Change Vehicle Interior - Changes the vehicle interior properties of a vehicle. Edit the map id, x, y, or direction. For example, if your player purchases an upgraded interior, you can change the map id to an upgraded interior map.
Change Vehicle Location - Changes the vehicle location to the given map/x/y. You can also specify a direction to face.
Change Vehicle Image - Change a custom vehicle's image
Change Vehicle BGM - Change a custom vehicle's BGM
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 custom vehicle data may not reflect accurately in saved games, as the saved game will still perform the same behavior for the custom vehicle before you changed it in the plugin parameters.
✘ Removing this plugin may cause saved games from when this plugin was active to no longer function correctly.Removing this plugin may cause saved games to crash if any custom vehicles were already added to save data. See [CGMZ] Patch documentation for how to patch saved data if you would like to remove this plugin and still use your saved games from when this plugin was active.
Filename
The filename for this plugin MUST remain CGMZ_CustomVehicles.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 [CGMZ] Vehicle Landing Restriction options to Custom Vehicles
- Added [CGMZ] Vehicle Encounters options to Custom Vehicles
- Integration with [CGMZ] Vehicle Interiors
- Added Map Links to transfer maps with vehicles
- Added option to ignore events while on vehicle
- Added Through option to passage settings
- Added plugin command to change vehicle location
- Added plugin command to change vehicle image
- Added plugin command to change vehicle bgm
- Added switch toggle on/off with vehicle get on/off
- Added option to not have a map link gamepad button
- Many location parameters converted to new location parameter type
- Many direction parameters converted to select type
- Fade type parameter converted to select type