Rpg Maker Developers Group

 Introduction
 ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞
 This plugin introduces a completely separate custom vehicle system.
 Default RPG Maker vehicles (Boat, Ship, Airship) are NOT modified
 and will continue to work exactly as in the base engine.

 Custom vehicles are independent, with their own mechanics and
 movement system, enabling fully customizable vehicles with features
 beyond the default system.

 Default engine behaviors:
 → Vehicle direction is not saved when exiting
 → Airships are boarded from above
 → There is no land vehicle type

 Custom vehicle improvements:
 → Direction is saved when exiting
 → Airships use a dynamic altitude system and can be boarded like
   boats/ships (side boarding)
 → Land vehicles introduce a new type that behaves like the player
 → Additional mechanics for boats and ships

 Some features are marked PRO and only function in the paid version.


 Features
 ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞
 → Create Land Vehicles (player-style movement)
 → Create Boats, Ships, and Airships
 → Individual Side boarding for all vehicle types
 → Individual vehicle speed
 → Individual speed modifiers (PRO)
 → Vehicle BGM (per vehicle)
 → Vehicle fuel system (PRO)
 → Vehicle key requirements (PRO)
 → Vehicle battlebacks (PRO)

 Airships include a dynamic altitude system:
 → Altitude affects airship height and perspective
 → Higher altitude scales the airship larger
 → Shadow scales smaller with altitude
 → Map depth adjusts for flying height
 → Regions can block specific altitude levels

 Fuel (PRO) can scale consumption based on altitude.


 Fuel System (PRO)
 ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞
 Under construction and coming in a future update.


 Vehicle Keys (PRO)
 ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞
 Under construction and coming in a future update.


 Speed Modifiers (PRO)
 ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞
 Under construction and coming in a future update.


 Vehicle Battlebacks (PRO)
 ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞
 Under construction and coming in a future update.


 Vehicle Interaction
 ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞
 Vehicle transfers and interactions are controlled via either
 event note tags or comment tags:

 <allow vehicle>   => Any vehicle can interact
 <allow land>      => Only land vehicles can interact
 <allow boat>      => Only boats can interact
 <allow ship>      => Only ships can interact
 <allow airship>   => Only airships can interact

 Boolean addon (optional):

 <allow … true> → Vehicle and player can interact
 <allow … false> or omit → Only the specified vehicle(s) can interact

 Example:
   <allow land true>  => Land vehicles and player can interact 


 Vehicle Trigger Priority
 ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞
 RPG Maker events can use three priority types:

 Below Characters
 Same as Characters
 Above Characters

 When the parameter "Vehicle Type Triggers" is enabled,
 custom vehicles interact with events based on realistic
 physical behavior:

 Land / Boat / Ship
 → Can trigger events:
   Below Characters
   Same as Characters
 → Cannot trigger events:
   Above Characters

 Airships
 → Can trigger events:
   Above Characters
 → Cannot trigger events:
   Below Characters
   Same as Characters

 If the parameter is disabled, vehicles can trigger events
 using any priority type.


 Scriptcalls
 ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞
 Relocate a vehicle to a specific map position:
   $gameSystem.relocateCustomVehicle(index, mapId, x, y);

 Examples:
   $gameSystem.relocateCustomVehicle(4, 1, 10, 15);
   $gameSystem.relocateCustomVehicle("Speedboat", 1, 10, 15);
   $gameSystem.relocateCustomVehicle("Speedboat", this._mapId, 10, 15);


 Set the vehicle location on the current map:
   $gameSystem.setCustomVehicleLocation(index, x, y, mapId);

 Examples:
   $gameSystem.setCustomVehicleLocation(4, 12, 18);
   $gameSystem.setCustomVehicleLocation("Speedboat", 12, 18);
   $gameSystem.setCustomVehicleLocation("Speedboat", 12, 18, 5);


 Summon a vehicle near the player:
   $gameSystem.summonCustomVehicle(index, options);

 index = vehicle ID or vehicle name

 Options:
 → board        => Board immediately after summoning (default: false)
 → permanent    => Vehicle remains on the map (default: false)
 → exitDespawn  => Vehicle disappears when exiting (default: false)

 Examples:
   $gameSystem.summonCustomVehicle(4, {
       board: false,
       permanent: false,
       exitDespawn: false
   });

 Short version:
   $gameSystem.summonCustomVehicle("Speedboat", { board: true });

 
 Checking Vehicle State
 ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞
 Returns true/false depending on whether the player is inside a custom vehicle:
   $gameSystem.isInCustomVehicle(type)

 Examples:
   $gameSystem.isInCustomVehicle()
       => true if in any custom vehicle
   $gameSystem.isInCustomVehicle("ship")
       => true if driving a ship

 Valid vehicle types:
   "land"
   "boat"
   "ship"
   "airship"

 If omitted, all vehicles are checked.