Add a faction vehicle pool and limit battles to faction vehicles

Leaders can put vehicles into the faction pool with /faction vehicle
transfer pool, using the same right-click and owner consent as an
installation transfer. Pool vehicles are owned by the leader in
VehicleFramework, the faction bank pays their upkeep (shown as Vehicle
Upkeep on the ledger), and the military menu lists them with artillery
used against artillery slots. Vehicles that belong in an installation
are refused, and so is artillery once every slot is used.

In a campaign battle, pool vehicles are allowed for their own side,
installation vehicles only when their installation is in play, and
personal or unregistered vehicles never.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

Author: ryanbarlow97

src/main/java/net/tfminecraft/simplefactions/SimpleFactions.java

@@ -165,6 +165,9 @@ public class SimpleFactions extends JavaPlugin{
 			new InstallationVehicleOwnerSync(vehicleRegistry);
 	private final InstallationVehicleService installationVehicleService =
 			new InstallationVehicleService(vehicleRegistry, installationVehicleOwnerSync);
+	private final net.tfminecraft.simplefactions.vehicles.pool.FactionVehiclePoolService factionVehiclePoolService =
+			new net.tfminecraft.simplefactions.vehicles.pool.FactionVehiclePoolService(
+					vehicleRegistry, installationVehicleOwnerSync);
 	private final InstallationVehicleUnberthService installationVehicleUnberthService =
 			new InstallationVehicleUnberthService(vehicleRegistry);
 	private final VehicleTransferSessionManager vehicleTransferSessionManager =
@@ -176,8 +179,8 @@ public class SimpleFactions extends JavaPlugin{
 	private final VehicleTransferConsentService vehicleTransferConsentService =
 			new VehicleTransferConsentService(
 					installationVehicleService,
-					vehicleRegistry,
-					vehicleTransferSessionManager);
+					vehicleTransferSessionManager,
+					factionVehiclePoolService);
 	private final VehicleRegistryClaimService vehicleRegistryClaimService =
 			new VehicleRegistryClaimService(vehicleRegistry);
 	private final VehicleRegistryClaimListener vehicleRegistryClaimListener =
@@ -187,7 +190,8 @@ public class SimpleFactions extends JavaPlugin{
 			vehicleTransferSessionManager,
 			vehicleRegistry,
 			installationVehicleService,
-			vehicleTransferConsentService);
+			vehicleTransferConsentService,
+			factionVehiclePoolService);
 	private final VehicleSpawnListener vehicleSpawnListener =
 			new VehicleSpawnListener(installationVehicleOwnerSync);
 	private final BattleVehicleEligibilityService.Listener battleVehicleEligibilityListener =

src/main/java/net/tfminecraft/simplefactions/guild/income/Cashflow.java

@@ -41,6 +41,7 @@ public enum Cashflow {
     UPGRADES_UPKEEP("#c46054Upgrades Upkeep", true, false),
     PENALTIES("#c74c3fPenalties", true, false),
     INSTALLATIONS("#706964Installations", true, false),
+    VEHICLE_UPKEEP("#a6659fVehicle Upkeep", true, false),
     MILITARY_UPKEEP("#a6659fMilitary Upkeep", true, false),
     NODES("#8a7a5cNodes", true, false);
 

src/main/java/net/tfminecraft/simplefactions/guild/income/Ledger.java

@@ -7,6 +7,8 @@
 import java.util.Set;
 import java.util.function.ToDoubleFunction;
 
+import net.tfminecraft.simplefactions.vehicles.pool.FactionVehiclePoolService;
+
 import org.bukkit.Bukkit;
 
 import net.tfminecraft.simplefactions.SimpleFactions;
@@ -56,6 +58,13 @@ public static void setNodeUpkeepLookup(ToDoubleFunction<Guild> lookup) {
         nodeUpkeepLookup = lookup == null ? guild -> 0.0 : lookup;
     }
 
+    // Pool vehicle upkeep is withdrawn in VehicleUpkeepService. This lookup is the ledger line.
+    private static ToDoubleFunction<String> vehiclePoolUpkeep = FactionVehiclePoolService::dailyUpkeepOf;
+
+    public static void setVehiclePoolUpkeepForTests(ToDoubleFunction<String> lookup) {
+        vehiclePoolUpkeep = lookup == null ? FactionVehiclePoolService::dailyUpkeepOf : lookup;
+    }
+
     public Ledger(Guild guild) {
         this.guild = guild;
     }
@@ -280,6 +289,12 @@ public double getIncome(Cashflow cashflow) {
                     amount -= InstallationConfigLoader.getDailyUpkeep(installation.getKind());
                 }
                 break;
+            case VEHICLE_UPKEEP:
+                if (!guild.isBase()) {
+                    return 0;
+                }
+                amount = -vehiclePoolUpkeep.applyAsDouble(f.getId());
+                break;
             case MILITARY_UPKEEP:
                 if (guild.isBase() && f.getMilitary() != null) {
                     amount = -f.getMilitary().getTotalUpkeep();
@@ -447,6 +462,7 @@ public double getNetIncome() {
                 case TRADE_UPKEEP:
                 case UPGRADES_UPKEEP:
                 case INSTALLATIONS:
+                case VEHICLE_UPKEEP:
                 case MILITARY_UPKEEP:
                 case NODES:
                 case PENALTIES:
@@ -518,6 +534,7 @@ public double getDividendBase() {
                 case TRADE_UPKEEP:
                 case UPGRADES_UPKEEP:
                 case INSTALLATIONS:
+                case VEHICLE_UPKEEP:
                 case MILITARY_UPKEEP:
                 case NODES:
                 case PENALTIES:
@@ -794,7 +811,8 @@ private void applySettlementFor(Cashflow cf, DailyGuildTransfers buffer) {
             // TRADE is paid here and nowhere else, so the bank moves by what the ledger shows.
             case TRADE:
             case TRADE_UPKEEP:
-            // INSTALLATIONS: withdrawn in Faction.newDay(), so getIncome() is ledger GUI display only
+            // INSTALLATIONS: withdrawn in Faction.newDay(), so getIncome() is ledger GUI display only.
+            // VEHICLE_UPKEEP: withdrawn in VehicleUpkeepService for the faction pool.
             case UPGRADES_UPKEEP:
             case PENALTIES:
             case CITIZENS:

src/main/java/net/tfminecraft/simplefactions/managers/inventory/MilitaryCreator.java

@@ -2,6 +2,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Set;
 
 import org.bukkit.Material;
 import org.bukkit.NamespacedKey;
@@ -18,6 +19,11 @@
 import net.tfminecraft.simplefactions.mercenary.company.MercenaryCompany;
 import net.tfminecraft.simplefactions.objects.Faction;
 import net.tfminecraft.simplefactions.utils.Formatter;
+import net.tfminecraft.simplefactions.vehicles.maintenance.VehicleMaintenanceStore;
+import net.tfminecraft.simplefactions.vehicles.pool.FactionVehiclePoolLore;
+import net.tfminecraft.simplefactions.vehicles.pool.FactionVehiclePoolService;
+import net.tfminecraft.simplefactions.vehicles.registry.PlayerVehicleRecord;
+import net.tfminecraft.simplefactions.vehicles.registry.PlayerVehicleRegistry;
 import net.tfminecraft.simplefactions.enums.FactionModifiers;
 import net.tfminecraft.simplefactions.keys.Keys;
 import net.tfminecraft.tlibs.TLibs;
@@ -182,4 +188,31 @@ public ItemStack createRegimentDecreaseButton(Faction f, Regiment r) {
 		i.setItemMeta(meta);
 		return i;
 	}
+
+	@SuppressWarnings("deprecation")
+	public ItemStack createVehiclePoolIcon(Faction f) {
+		ItemStack item = new ItemStack(Material.MINECART, 1);
+		ItemMeta meta = item.getItemMeta();
+		meta.setDisplayName("§eVehicle Pool");
+		PlayerVehicleRegistry registry = SimpleFactions.plugin == null
+				? null
+				: SimpleFactions.getVehicleRegistry();
+		List<PlayerVehicleRecord> pool = registry == null || f == null
+				? List.of()
+				: registry.getPoolVehicles(f.getId());
+		Set<String> unpaid = Set.of();
+		SimpleFactions plugin = SimpleFactions.getInstance();
+		if (plugin != null) {
+			VehicleMaintenanceStore store = plugin.getVehicleMaintenanceStore();
+			if (store != null) {
+				unpaid = store.unpaidUuids();
+			}
+		}
+		meta.setLore(FactionVehiclePoolLore.lines(
+				pool,
+				FactionVehiclePoolService.artillerySlots(f),
+				unpaid));
+		item.setItemMeta(meta);
+		return item;
+	}
 }

src/main/java/net/tfminecraft/simplefactions/managers/inventory/MilitaryView.java

@@ -74,6 +74,7 @@ public void militaryView(Inventory i, Player player, Faction f, boolean open) {
 			}
 
 		}
+		i.setItem(49, creator.createVehiclePoolIcon(f));
 		i.setItem(53, inv.createBackButton(SFGUI.MILITARY_VIEW));
 		if(open) player.openInventory(i);
 	}

src/main/java/net/tfminecraft/simplefactions/objects/request/VehicleTransferConsentRequest.java

@@ -12,6 +12,7 @@ public final class VehicleTransferConsentRequest extends Request {
     private final String vehicleTypeId;
     private final UUID ownerUuid;
     private final UUID proposerLeaderUuid;
+    private final boolean pool;
 
     public VehicleTransferConsentRequest(
             Guild sender,
@@ -21,13 +22,27 @@ public VehicleTransferConsentRequest(
             String vehicleTypeId,
             UUID ownerUuid,
             UUID proposerLeaderUuid) {
+        this(sender, installationId, installationName, vehicleUuid, vehicleTypeId,
+                ownerUuid, proposerLeaderUuid, false);
+    }
+
+    public VehicleTransferConsentRequest(
+            Guild sender,
+            String installationId,
+            String installationName,
+            String vehicleUuid,
+            String vehicleTypeId,
+            UUID ownerUuid,
+            UUID proposerLeaderUuid,
+            boolean pool) {
         super(sender);
         this.installationId = installationId;
         this.installationName = installationName;
         this.vehicleUuid = vehicleUuid;
         this.vehicleTypeId = vehicleTypeId;
         this.ownerUuid = ownerUuid;
         this.proposerLeaderUuid = proposerLeaderUuid;
+        this.pool = pool;
         this.time = System.currentTimeMillis()
                 + InstallationConfigLoader.getTransferRequestTimeoutSeconds() * 1000L;
     }
@@ -55,4 +70,8 @@ public UUID getOwnerUuid() {
     public UUID getProposerLeaderUuid() {
         return proposerLeaderUuid;
     }
+
+    public boolean isPool() {
+        return pool;
+    }
 }

src/main/java/net/tfminecraft/simplefactions/utils/TabCompletion.java

@@ -237,7 +237,12 @@ else if(cmd.getName().equalsIgnoreCase("faction")
 							args.length >= 2 ? args[1] : "");
 				}
 				if(args.length == 3 && args[1].equalsIgnoreCase("transfer")) {
-					return completeInstallationIds(p, args[2], false);
+					List<String> ids = completeInstallationIds(p, args[2], false);
+					String prefix = args[2] == null ? "" : args[2];
+					if ("pool".startsWith(prefix.toLowerCase(java.util.Locale.ROOT))) {
+						ids.add(0, "pool");
+					}
+					return ids;
 				}
 				if(args.length == 4 && args[1].equalsIgnoreCase("maintenance") && args[2].equalsIgnoreCase("pay")) {
 					return VehicleTabCompletions.filter(List.of("bank"), args[3]);

src/main/java/net/tfminecraft/simplefactions/vehicles/VehicleFactionCommands.java

@@ -8,6 +8,7 @@
 import net.tfminecraft.simplefactions.vehicles.maintenance.VehicleMaintenancePayService.PaymentSource;
 
 import net.tfminecraft.simplefactions.vehicles.berth.VehicleTransferSessionManager.VehicleTransferSession;
+import net.tfminecraft.simplefactions.vehicles.pool.FactionVehiclePoolService;
 import net.tfminecraft.simplefactions.vehicles.berth.VehicleInstallationLockService;
 import net.tfminecraft.simplefactions.vehicles.berth.VehicleTransferMessages;
 import net.tfminecraft.simplefactions.vehicles.maintenance.VehicleMaintenancePaySessionManager.VehicleMaintenancePaySession;
@@ -34,6 +35,10 @@ public static void armTransfer(Player player, String installationId) {
             player.sendMessage(VehicleMaintenanceMessages.transferUsage());
             return;
         }
+        if (FactionVehiclePoolService.isPoolTarget(installationId)) {
+            armPoolTransfer(player);
+            return;
+        }
         Installation installation = faction.getInstallationHandler().getById(installationId);
         if (installation == null) {
             player.sendMessage(VehicleTransferMessages.unknownInstallation());
@@ -56,6 +61,16 @@ public static void armTransfer(Player player, String installationId) {
         player.sendMessage(VehicleTransferMessages.commandArmed(installation));
     }
 
+    private static void armPoolTransfer(Player player) {
+        SimpleFactions plugin = SimpleFactions.getInstance();
+        long timeoutMillis = InstallationConfigLoader.getTransferRequestTimeoutSeconds() * 1000L;
+        plugin.getVehicleMaintenancePaySessionManager().clear(player.getUniqueId());
+        plugin.getVehicleTransferSessionManager().put(
+                player.getUniqueId(),
+                new VehicleTransferSession(null, System.currentTimeMillis() + timeoutMillis, true));
+        player.sendMessage(VehicleTransferMessages.poolCommandArmed());
+    }
+
     public static void armMaintenancePay(Player player) {
         armMaintenancePay(player, PaymentSource.POUCH);
     }

src/main/java/net/tfminecraft/simplefactions/vehicles/battle/BattleVehicleEligibilityService.java

@@ -31,9 +31,12 @@ public final class BattleVehicleEligibilityService {
 	private BattleVehicleEligibilityService() {}
 
 	public static boolean isEligible(War war, String factionId, PlayerVehicleRecord record) {
-		if (war == null || factionId == null || factionId.isBlank() || record == null) {
+		if (war == null || factionId == null || factionId.isBlank()) {
 			return true;
 		}
+		if (record == null) {
+			return false;
+		}
 		return isEligible(war, factionId, record.getVehicleTypeId(), record);
 	}
 
@@ -42,17 +45,44 @@ public static boolean isEligible(
 		if (war == null || factionId == null || factionId.isBlank()) {
 			return true;
 		}
-		if (!VehicleCategoryRules.isBerthableType(vehicleTypeId)) {
-			return true;
+		return decide(war, factionId, vehicleTypeId, berthRecord) == BattleVehicleEligibilityResult.ALLOWED;
+	}
+
+	static BattleVehicleEligibilityResult decide(
+			War war, String factionId, String vehicleTypeId, PlayerVehicleRecord record) {
+		if (record != null && record.getMode() == OwnershipMode.POOL) {
+			return poolOnPlayerSide(war, factionId, record.getFactionId())
+					? BattleVehicleEligibilityResult.ALLOWED
+					: BattleVehicleEligibilityResult.DENIED_POOL_SIDE;
 		}
-		if (berthRecord == null || berthRecord.getMode() != OwnershipMode.INSTALLATION) {
+		if (record != null && record.getMode() == OwnershipMode.INSTALLATION) {
+			if (!VehicleCategoryRules.isBerthableType(vehicleTypeId)) {
+				return BattleVehicleEligibilityResult.ALLOWED;
+			}
+			String installationId = record.getInstallationId();
+			if (installationId == null || installationId.isBlank()) {
+				return BattleVehicleEligibilityResult.DENIED_NOT_BERTHED;
+			}
+			if (!BattleInstallationInPlayService.isInPlay(war, factionId, installationId)) {
+				return BattleVehicleEligibilityResult.DENIED_NOT_COMMITTED;
+			}
+			return BattleVehicleEligibilityResult.ALLOWED;
+		}
+		return BattleVehicleEligibilityResult.DENIED_NOT_FACTION_VEHICLE;
+	}
+
+	private static boolean poolOnPlayerSide(War war, String playerFactionId, String vehicleFactionId) {
+		if (vehicleFactionId == null || vehicleFactionId.isBlank()) {
 			return false;
 		}
-		String installationId = berthRecord.getInstallationId();
-		if (installationId == null || installationId.isBlank()) {
+		Faction playerFaction = FactionManager.getByString(playerFactionId);
+		Faction vehicleFaction = FactionManager.getByString(vehicleFactionId);
+		if (playerFaction == null || vehicleFaction == null) {
 			return false;
 		}
-		return BattleInstallationInPlayService.isInPlay(war, factionId, installationId);
+		var playerSide = war.getSide(playerFaction);
+		var vehicleSide = war.getSide(vehicleFaction);
+		return playerSide != null && playerSide.equals(vehicleSide);
 	}
 
 	public static BattleVehicleEligibilityResult check(
@@ -85,24 +115,8 @@ public static BattleVehicleEligibilityResult check(
 			return BattleVehicleEligibilityResult.NOT_CAMPAIGN_BATTLE;
 		}
 
-		String vehicleTypeId = vehicle.getId();
-		if (!VehicleCategoryRules.isBerthableType(vehicleTypeId)) {
-			return BattleVehicleEligibilityResult.ALLOWED;
-		}
-
 		Optional<PlayerVehicleRecord> recordOpt = registry.getByVehicleUuid(vehicle.getUUID());
-		PlayerVehicleRecord record = recordOpt.orElse(null);
-		if (record == null || record.getMode() != OwnershipMode.INSTALLATION) {
-			return BattleVehicleEligibilityResult.DENIED_NOT_BERTHED;
-		}
-		String installationId = record.getInstallationId();
-		if (installationId == null || installationId.isBlank()) {
-			return BattleVehicleEligibilityResult.DENIED_NOT_BERTHED;
-		}
-		if (!BattleInstallationInPlayService.isInPlay(war, faction.getId(), installationId)) {
-			return BattleVehicleEligibilityResult.DENIED_NOT_COMMITTED;
-		}
-		return BattleVehicleEligibilityResult.ALLOWED;
+		return decide(war, faction.getId(), vehicle.getId(), recordOpt.orElse(null));
 	}
 
 	public static Player resolveNotifyPlayer(ActiveVehicle vehicle, PlayerVehicleRegistry registry) {
@@ -131,12 +145,16 @@ public enum BattleVehicleEligibilityResult {
 		NOT_CAMPAIGN_BATTLE,
 		DENIED_PRE_BATTLE_WARBAND,
 		DENIED_NOT_BERTHED,
-		DENIED_NOT_COMMITTED;
+		DENIED_NOT_COMMITTED,
+		DENIED_NOT_FACTION_VEHICLE,
+		DENIED_POOL_SIDE;
 
 		public boolean isDenied() {
 			return this == DENIED_PRE_BATTLE_WARBAND
 					|| this == DENIED_NOT_BERTHED
-					|| this == DENIED_NOT_COMMITTED;
+					|| this == DENIED_NOT_COMMITTED
+					|| this == DENIED_NOT_FACTION_VEHICLE
+					|| this == DENIED_POOL_SIDE;
 		}
 	}
 
@@ -154,6 +172,10 @@ public static String forResult(BattleVehicleEligibilityResult result) {
 						"§cThis vehicle must be berthed at a committed installation for this battle.";
 				case DENIED_NOT_COMMITTED ->
 						"§cThis vehicle is berthed at an installation not committed for this battle.";
+				case DENIED_NOT_FACTION_VEHICLE ->
+						"§cOnly faction pool and installation vehicles can be used in a campaign battle.";
+				case DENIED_POOL_SIDE ->
+						"§cThis pool vehicle belongs to a faction that is not on your side.";
 				case ALLOWED, NOT_CAMPAIGN_BATTLE -> null;
 			};
 		}