fix(vehicles): replace the personal vehicle when the server forces replace

Also spawn clear of the personal vehicle instead of inside it when it is kept.

Author: TomGrobbe

assets/enhanced/language/de.json

@@ -1877,6 +1877,7 @@
     "vehiclespawner.category.subtitle": "Fahrzeug-Spawner-Menü",
     "vehiclespawner.link.desc": "Ein Fahrzeug spawnen.",
     "vehiclespawner.oldvehicleremoved": "Dein altes Fahrzeug wurde entfernt. Schalte ~y~Vorheriges Fahrzeug ersetzen~s~ aus, wenn du es beim nächsten Mal behalten willst.",
+    "vehiclespawner.personalvehiclereplaced": "Dein persönliches Fahrzeug wurde entfernt und vergessen. Auf diesem Server darfst du nur ein Fahrzeug gleichzeitig haben.",
     "vehiclespawner.replaceprevious": "Vorheriges Fahrzeug ersetzen",
     "vehiclespawner.replaceprevious.binding": "Vorheriges Fahrzeug behalten oder ersetzen",
     "vehiclespawner.replaceprevious.button.off": "Vorheriges ersetzen: Aus",

assets/enhanced/language/es.json

@@ -1877,6 +1877,7 @@
     "vehiclespawner.category.subtitle": "Menú del generador de vehículos",
     "vehiclespawner.link.desc": "Genera un vehículo.",
     "vehiclespawner.oldvehicleremoved": "Se ha eliminado tu vehículo anterior. Desactiva ~y~Reemplazar el vehículo anterior~s~ si la próxima vez quieres conservarlo.",
+    "vehiclespawner.personalvehiclereplaced": "Tu vehículo personal se ha eliminado y olvidado. Este servidor solo te permite tener un vehículo a la vez.",
     "vehiclespawner.replaceprevious": "Reemplazar el vehículo anterior",
     "vehiclespawner.replaceprevious.binding": "Conservar o reemplazar el vehículo anterior",
     "vehiclespawner.replaceprevious.button.off": "Reemplazar el anterior: no",

assets/enhanced/language/fr.json

@@ -1877,6 +1877,7 @@
     "vehiclespawner.category.subtitle": "Menu du générateur de véhicules",
     "vehiclespawner.link.desc": "Faire apparaître un véhicule.",
     "vehiclespawner.oldvehicleremoved": "Votre ancien véhicule a été supprimé. Désactivez ~y~Remplacer le véhicule précédent~s~ si vous voulez le garder la prochaine fois.",
+    "vehiclespawner.personalvehiclereplaced": "Votre véhicule personnel a été supprimé et oublié. Ce serveur ne vous autorise qu'un seul véhicule à la fois.",
     "vehiclespawner.replaceprevious": "Remplacer le véhicule précédent",
     "vehiclespawner.replaceprevious.binding": "Garder ou remplacer le véhicule précédent",
     "vehiclespawner.replaceprevious.button.off": "Remplacer le précédent : non",

assets/enhanced/language/nl.json

@@ -1877,6 +1877,7 @@
     "vehiclespawner.category.subtitle": "Voertuigspawnermenu",
     "vehiclespawner.link.desc": "Spawn een voertuig.",
     "vehiclespawner.oldvehicleremoved": "Je oude voertuig is verwijderd. Zet ~y~Vorig voertuig vervangen~s~ uit als je het de volgende keer wilt houden.",
+    "vehiclespawner.personalvehiclereplaced": "Je persoonlijke voertuig is verwijderd en vergeten. Op deze server mag je maar één voertuig tegelijk hebben.",
     "vehiclespawner.replaceprevious": "Vorig voertuig vervangen",
     "vehiclespawner.replaceprevious.binding": "Vorig voertuig behouden of vervangen",
     "vehiclespawner.replaceprevious.button.off": "Vorige vervangen: uit",

src/Client/vMenu.Enhanced.MenuFramework/Localization/Languages/EnglishStrings.cs

@@ -343,6 +343,7 @@ internal static class EnglishStrings
             [Loc.VehicleSpawner.SpawnInsideBinding] = "Spawn vehicles inside or outside",
             [Loc.VehicleSpawner.ReplacePreviousBinding] = "Keep or replace the previous vehicle",
             [Loc.VehicleSpawner.OldVehicleRemoved] = "Your old vehicle was removed. Turn off ~y~Replace Previous Vehicle~s~ if you want to keep it next time.",
+            [Loc.VehicleSpawner.PersonalVehicleReplaced] = "Your personal vehicle was removed and forgotten. This server only lets you keep one vehicle at a time.",
             [Loc.VehicleSpawner.TooManySpawns] = "You are spawning vehicles too quickly. Try again in ~y~{seconds}~s~ second(s).",
 
             [Loc.OnlinePlayers.Title] = "Online Players",

src/Client/vMenu.Enhanced.MenuFramework/Localization/Loc.VehicleSpawner.cs

@@ -56,6 +56,8 @@ public static class VehicleSpawner
 
         public const string OldVehicleRemoved = "vehiclespawner.oldvehicleremoved";
 
+        public const string PersonalVehicleReplaced = "vehiclespawner.personalvehiclereplaced";
+
         public const string TooManySpawns = "vehiclespawner.toomanyspawns";
     }
 }

src/Client/vMenu.Enhanced.Menus/Vehicles/Personal/PersonalVehicle.cs

@@ -170,6 +170,18 @@ public static async Task ForgetAsync()
         }
     }
 
+    public static async Task SurrenderAsync()
+    {
+        if (!IsMarked)
+        {
+            return;
+        }
+
+        await ServerActions.InvokeAsync(ActionIds.PersonalVehicle.Forget);
+
+        Release();
+    }
+
     public static async Task DeleteAsync()
     {
         if (_busy || !Guarded())

src/Client/vMenu.Enhanced.Menus/Vehicles/VehicleSpawnOptions.cs

@@ -18,6 +18,8 @@ public static void SetSpawnInside(bool spawnInside) =>
     public static bool CanKeepPrevious =>
         ClientPermissions.IsAllowed(VehicleSpawnerPermissions.AllowKeepPreviousVehicle);
 
+    public static bool ForcedReplace => !CanKeepPrevious;
+
     public static void SetReplacePrevious(bool replace)
     {
         if (!replace && !CanKeepPrevious)

src/Client/vMenu.Enhanced.Menus/Vehicles/VehicleSpawning.cs

@@ -60,11 +60,13 @@ public static class VehicleSpawning
             rpm = Native.GetVehicleCurrentRpm(currentVehicle.Handle);
         }
 
-        var position = SpawnPosition(ped, currentVehicle, hash, spawnInside);
+        var removingCurrent = WillRemoveCurrent(ped.Handle, currentVehicle?.Handle ?? 0);
+
+        var position = SpawnPosition(ped, currentVehicle, hash, spawnInside, removingCurrent);
 
         var heading = spawnInside ? ped.Heading : ped.Heading + 90f;
 
-        RemovePrevious(ped.Handle, currentVehicle?.Handle ?? 0);
+        await RemovePreviousAsync(ped.Handle, currentVehicle?.Handle ?? 0, removingCurrent);
 
         var orphanMode = VehicleSpawnerSettings.NormaliseOrphanMode(ClientConfig.Value(VehicleSpawnerSettings.OrphanMode));
 
@@ -128,7 +130,7 @@ private static void ReportSpawn(int entity)
         API.EmitServer(VehicleEvents.Spawned, Native.NetworkGetNetworkIdFromEntity(entity));
     }
 
-    private static Vector3 SpawnPosition(Ped ped, Vehicle? currentVehicle, uint hash, bool spawnInside)
+    private static Vector3 SpawnPosition(Ped ped, Vehicle? currentVehicle, uint hash, bool spawnInside, bool removingCurrent)
     {
         if (spawnInside && currentVehicle is null)
         {
@@ -139,9 +141,7 @@ private static Vector3 SpawnPosition(Ped ped, Vehicle? currentVehicle, uint hash
 
         var clearance = (Math.Abs((spawnedMin - spawnedMax).Y) / 2) + 1f;
 
-        var replace = VehicleSpawnOptions.ReplacePrevious;
-
-        if (currentVehicle is not null && replace && currentVehicle.GetPedInVehicleSeat(-1, false) == ped.Handle)
+        if (currentVehicle is not null && removingCurrent)
         {
             return currentVehicle.Position;
         }
@@ -158,15 +158,15 @@ private static Vector3 SpawnPosition(Ped ped, Vehicle? currentVehicle, uint hash
         return Native.GetOffsetFromEntityInWorldCoords(currentVehicle.Handle, 0f, clearance, 0f);
     }
 
-    private static void RemovePrevious(int ped, int currentVehicle)
+    private static async Task RemovePreviousAsync(int ped, int currentVehicle, bool removingCurrent)
     {
         var replace = VehicleSpawnOptions.ReplacePrevious;
 
         if (MayRemove(_previousVehicle, ped))
         {
             if (replace)
             {
-                VehicleDeletion.DeleteLocally(_previousVehicle);
+                await RemoveAsync(_previousVehicle, notify: false);
             }
             else if (!ClientConfig.Value(VehicleSpawnerSettings.KeepSpawnedVehiclesPersistent))
             {
@@ -177,26 +177,60 @@ private static void RemovePrevious(int ped, int currentVehicle)
             _previousVehicle = 0;
         }
 
-        if (!replace || currentVehicle == 0 || !Native.DoesEntityExist(currentVehicle))
+        if (!removingCurrent)
         {
             return;
         }
 
-        if (PersonalVehicle.Owns(currentVehicle))
+        _previousVehicle = _previousVehicle == currentVehicle ? 0 : _previousVehicle;
+
+        await RemoveAsync(currentVehicle, notify: true);
+    }
+
+    private static async Task RemoveAsync(int vehicle, bool notify)
+    {
+        if (vehicle == 0 || !Native.DoesEntityExist(vehicle))
         {
             return;
         }
 
-        if (Native.GetPedInVehicleSeat(currentVehicle, DriverSeat, false) != ped)
+        var personal = PersonalVehicle.Owns(vehicle);
+
+        if (personal)
+        {
+            await PersonalVehicle.SurrenderAsync();
+        }
+
+        VehicleDeletion.DeleteLocally(vehicle);
+
+        if (personal)
         {
+            Notifications.Info(MenuText.Key(Loc.VehicleSpawner.PersonalVehicleReplaced));
+
             return;
         }
 
-        _previousVehicle = _previousVehicle == currentVehicle ? 0 : _previousVehicle;
+        if (notify)
+        {
+            Notifications.Info(MenuText.Key(Loc.VehicleSpawner.OldVehicleRemoved));
+        }
+    }
 
-        VehicleDeletion.DeleteLocally(currentVehicle);
+    private static bool WillRemoveCurrent(int ped, int currentVehicle)
+    {
+        if (!VehicleSpawnOptions.ReplacePrevious
+            || currentVehicle == 0
+            || !Native.DoesEntityExist(currentVehicle))
+        {
+            return false;
+        }
+
+        if (PersonalVehicle.Owns(currentVehicle) && !VehicleSpawnOptions.ForcedReplace)
+        {
+            return false;
+        }
 
-        Notifications.Info(MenuText.Key(Loc.VehicleSpawner.OldVehicleRemoved));
+        return Native.GetPedInVehicleSeat(currentVehicle, DriverSeat, false) == ped;
     }
 
     private static bool MayRemove(int vehicle, int ped)
@@ -206,7 +240,7 @@ private static bool MayRemove(int vehicle, int ped)
             return false;
         }
 
-        if (PersonalVehicle.Owns(vehicle))
+        if (PersonalVehicle.Owns(vehicle) && !VehicleSpawnOptions.ForcedReplace)
         {
             return false;
         }