fix(vehicles): keep clean now catches slowly building dirt

Author: TomGrobbe

src/Client/vMenu.Enhanced.Events/LocalVehicleTicks.cs

@@ -1,4 +1,4 @@
-using CitizenFX.FiveM.Client;
+using CitizenFX.FiveM.Client;
 
 using vMenu.Enhanced.Data.Ticks;
 using vMenu.Enhanced.Ticks;
@@ -456,14 +456,21 @@ private static void PollDirt()
 
         var gained = dirt - _dirt;
 
-        _dirt = dirt;
-
         // Washing moves the same number downwards, which is not getting dirty.
         if (vehicle == 0 || gained < DirtThreshold)
         {
+            // Dirt builds up slower than the threshold per poll, so the baseline only moves once a gain is
+            // reported. Moving it every poll would lose the whole build up a fraction at a time.
+            if (gained < 0f)
+            {
+                _dirt = dirt;
+            }
+
             return;
         }
 
+        _dirt = dirt;
+
         var dirtied = new VehicleDirtied(vehicle, dirt, gained);
 
         Dispatch.Raise(_dirtied, dirtied, nameof(VehicleDirtied));

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

@@ -1,8 +1,10 @@
-using CitizenFX.FiveM.Client;
+using CitizenFX.FiveM.Client;
 
+using vMenu.Enhanced.Data.Ticks;
 using vMenu.Enhanced.Events;
 using vMenu.Enhanced.Permissions;
 using vMenu.Enhanced.Storage;
+using vMenu.Enhanced.Ticks;
 
 using VehicleOptionsPermissions = vMenu.Enhanced.Data.Permissions.Menus.VehicleOptions;
 
@@ -12,8 +14,14 @@ namespace vMenu.Enhanced.Menus.Vehicles;
 // same distinction VehicleWash makes.
 public static class VehicleKeepClean
 {
+    // The dirt watcher only reports a gain big enough to be worth an event, so a slow drizzle of dirt can
+    // sit under it. This sweep is what catches that.
+    private const long SweepIntervalMs = 10000;
+
     private static bool _watching;
 
+    private static TickHandle? _sweep;
+
     public static bool Enabled => UserDefaults.VehicleKeepClean.Value && IsAllowed;
 
     private static bool IsAllowed => ClientPermissions.IsAllowed(VehicleOptionsPermissions.KeepClean);
@@ -23,6 +31,8 @@ public static void Initialize()
     {
         ClientPermissions.PermissionsChanged += Apply;
 
+        _sweep = TickRegistry.Register("Vehicle.KeepClean", Sweep, TickRate.Every(SweepIntervalMs), () => Enabled);
+
         Apply();
     }
 
@@ -45,6 +55,8 @@ private static void Apply()
 
         Watch(on);
 
+        _sweep?.Reevaluate();
+
         if (!on)
         {
             return;
@@ -74,6 +86,8 @@ private static void Watch(bool watching)
         LocalVehicleTicks.VehicleChanged -= OnChanged;
     }
 
+    private static void Sweep() => Wash(OwnVehicle.Driven());
+
     private static void OnDirtied(VehicleDirtied _) => Wash(OwnVehicle.Driven());
 
     // The dirt watcher re-seeds on a new vehicle rather than reporting it, so getting into one that is