WorldGuard and other plugins
The plugin's integrations.
WorldGuard
WorldGuard is optional: without it, the flags simply do not exist and everything else works. With WorldGuard, seven flags are registered for use on regions:
| Flag | Type | Effect |
|---|---|---|
vehicles-spawn | state | With deny, vehicles cannot be spawned inside the region. |
vehicles-drive | state | With deny, you cannot drive inside the region. |
vehicles-enter | state | With deny, vehicles cannot enter the region (they stop at the border). |
vehicles-exit | state | With deny, vehicles cannot leave the region. |
vehicles-limit | integer | Maximum vehicles on the road inside the region. |
vehicles-collision | state | With deny, vehicles inside the region have no collisions (no damage, no impacts with entities or vehicles). |
vehicles-speedlimit | map | Maximum speed in km/h per vehicle type, for example cars=50. The type is the model's typeId. |
/region flag town vehicles-drive deny
/region flag town vehicles-speedlimit cars=50Whoever has WorldGuard bypass skips vehicles-spawn and vehicles-drive. vehicles-enter and vehicles-exit look at the regions containing the vehicle's position and do not take parent regions into account.
PlaceholderAPI
PlaceholderAPI is optional (softdepend): without it, the plugin works and placeholders stay written as-is. With PlaceholderAPI installed, every text the plugin shows goes through PlaceholderAPI, with no exceptions: chat messages and the action bar, menu titles, names and descriptions (gui/*.yml), item names, company garages and the plate on vehicles. Without a player (the console), the server's own placeholders are resolved. Turn it off with placeholderapi: false in config.yml.
title: "%img_menu_garage%<white>Garage: {name}"
items:
vehicle:
name: "<white>{name}"
lore:
- "<gray>Balance: %vault_eco_balance_formatted%"
- ItemsAdder font images. Write
%img_name%in a button's title or name: the player sees the pack's image. The plugin does not depend on ItemsAdder, it only needs PlaceholderAPI. - Other plugins. Any placeholder registered with PlaceholderAPI works the same way (
%player_name%,%vault_...%...). - Order. Placeholders first, then colors and small caps: placeholder names are never altered. The plate on vehicles only gets placeholders.
- Plugin values. A name chosen by a player (vehicle, garage) stays literal: if it contains
%something%it is not read as a placeholder.
Vault and companies
Players pay with their Vault account (any compatible economy plugin): shop, selling between players, repairs, upgrades and fuel. The money from payments to the shop, repairs and fuel leaves the economy. Without an economy, paid features are unavailable, unless economy.free: true is set.
API for other plugins
EndlessVehicles registers the vehicle, garage, fuel, model and shop services in Bukkit's ServicesManager and fires events (VehicleEnterEvent, VehicleSpawnedEvent, VehicleCollisionEvent, VehicleUpgradeEvent, VehicleRefuelEvent and others, almost all of them cancellable). The API lives in the endlessvehicles-api module, described in the API page.