chore(menus): Messing around with old vMenu code inside a temporary vehicle spawner class to find bugs in Enhanced.

Note this is not how the new menu will be implemented, it's just testing and messing around to get a feel for what we need to fix or report before we can implement it properly.

Also update mistake in docs that was made up by a clanker.

And fix another broken native.

Author: TomGrobbe

docs/src/content/docs/getting-started.md

@@ -15,19 +15,18 @@ vMenu Enhanced is in early alpha. Installation and configuration steps are not f
 
 ### Filesystem permissions
 
-vMenu Enhanced writes files into its own resource folder (saved vehicles, outfits, and other
-persistent data). FiveM Enhanced blocks resources from writing to disk unless you explicitly
-grant permission, so add the following line to your `server.cfg` **before** the line that starts
-vMenu Enhanced:
+vMenu Enhanced writes files into its own resource folder (used for creating template files).
+FiveM Enhanced blocks resources from writing to disk unless you explicitly grant permission,
+so add the following line to your `server.cfg` **before** the line that starts vMenu Enhanced:
 
 ```cfg
 add_filesystem_permission vMenu.Enhanced write vMenu.Enhanced
 ensure vMenu.Enhanced
 ```
 
 Both names in that command are resource names: the first is the resource being granted access
-(vMenu Enhanced), the second is the resource whose folder it may write to (its own). If you renamed
-the resource folder, use your own folder name in both places.
+(vMenu Enhanced), the second is the resource whose folder it may write to (its own).
+It's important for this reason (and others) that you call the resource `vMenu.Enhanced`.
 
 :::danger[Order matters]
 The permission must be set before the resource starts. If `ensure vMenu.Enhanced` comes first,
@@ -37,7 +36,7 @@ console.
 
 ## Where things stand
 
-Setup instructions, configuration, and permissions documentation will land here as vMenu Enhanced becomes usable. 
+Setup instructions, configuration, and permissions documentation will land here as vMenu Enhanced becomes usable.
 In the meantime, follow along on the [GitHub repository](https://github.com/TomGrobbe/vMenu/) and the [Discord](https://vespura.com/discord).
 
 If you are running the current stable version for FiveM Legacy, use the [vMenu Legacy documentation](/vmenu/legacy/) instead.

src/Client/vMenu.Enhanced.BrokenNatives/NativeFixer.cs

@@ -1,4 +1,7 @@
+using System.Numerics;
+
 using CitizenFX.Base;
+using CitizenFX.Base.Data;
 using CitizenFX.FiveM.Client;
 
 namespace vMenu.Enhanced.BrokenNatives;
@@ -11,7 +14,7 @@ public static class NativeFixer
     internal static NativeApi nativeApi = BaseEntrypoint.NativeApi;
 
     /// <summary>
-    /// Replacement call for <see cref="Native.GetAllVehicleModels" /> because that return type is <pre>byte[]</pre>
+    /// Replacement call for <see cref="Native.GetAllVehicleModels()" /> because that return type is <em>byte[]</em>.
     /// </summary>
     /// <returns></returns>
     public static string[] GetAllVehicleModels()
@@ -20,4 +23,21 @@ public static string[] GetAllVehicleModels()
         nativeApi.Invoke(3612546629uL, "GetAllVehicleModels");
         return nativeApi.GetResObject(0).DeserializeTo<string[]>();
     }
+
+    /// <summary>
+    /// Replacement call for <see cref="Native.GetModelDimensions(uint, out Vector3, out Vector3)" /> because <em>nativeApi.PushArg(default(Vector3))</em> is not supported.
+    /// </summary>
+    /// <param name="p0"></param>
+    /// <param name="p1"></param>
+    /// <param name="p2"></param>
+    public static void GetModelDimensions(uint p0, out Vector3 p1, out Vector3 p2)
+    {
+        nativeApi.ResetContext();
+        nativeApi.PushArg(p0);
+        nativeApi.PushArg(default(ObjectArg));
+        nativeApi.PushArg(default(ObjectArg));
+        nativeApi.Invoke(14500376258260264975uL, "GetModelDimensions");
+        p1 = nativeApi.GetResVector(1).ToVector();
+        p2 = nativeApi.GetResVector(2).ToVector();
+    }
 }

src/Client/vMenu.Enhanced.Core/Main.cs

@@ -39,24 +39,10 @@ public async void Initialize()
             await API.Vehicles.RequestAndCreate(API.Hash("adder"), API.Players.Local.Position, 0, true, true, true);
         });
 
-        //foreach (var subClass in AppDomain.CurrentDomain.GetAssemblies().SelectMany(a => a.GetTypes()))
-        //{
-        //    if (subClass.Namespace == "vMenu.Enhanced.Configuration")
-        //    {
-        //        API.Log.Info("Found class inside vMenu.Enhanced.Configuration: {0}", subClass.Name);
-        //    }
-        //}
-
-        var menu = new Menu("Test menu", "vMenu.Enhanced");
+        var menu = new Menu("vMenu Enhanced", "Main Menu");
         MenuController.AddMenu(menu);
 
-        for (var i = 0; i < 3; i++)
-        {
-            menu.AddMenuItem(new MenuItem($"Menu item #{i + 1}"));
-        }
-
-        API.Log.Info("Creating and requesting vehicle spawner menu now.");
-        var vehicleSpawnerMenu = await (new VehicleSpawnerMenu()).GetMenu();
+        await (new VehicleSpawnerMenu()).Initialize();
 
     }
 }

src/Client/vMenu.Enhanced.Menus/VehicleSpawnerMenu.cs

@@ -1,3 +1,5 @@
+using System.Globalization;
+
 using CitizenFX.Base;
 using CitizenFX.FiveM.Client;
 using CitizenFX.FiveM.Client.Extensions;
@@ -13,57 +15,231 @@ namespace vMenu.Enhanced.Menus;
 public sealed class VehicleSpawnerMenu
 {
     internal static NativeApi nativeApi = BaseEntrypoint.NativeApi;
+    private static readonly TextInfo _textInfo = new CultureInfo("en-US", false).TextInfo;
 
-
-    public async Task<Menu> GetMenu()
+    public async Task Initialize()
     {
-
         var menu = new Menu("Vehicle Spawner", "Vehicle Spawner Menu");
         MenuController.AddSubmenu(MenuController.MainMenu, menu);
-        var linkBtn = new MenuItem("VehicleSpawner Menu", "Temporary vehicle spawner menu.") { Label = "»»»" };
+        var linkBtn = new MenuItem("VehicleSpawner Menu", "Temporary vehicle spawner menu.") { Label = "→" };
         MenuController.MainMenu.AddMenuItem(linkBtn);
         MenuController.BindMenuItem(MenuController.MainMenu, menu, linkBtn);
 
-        var vehicles = BrokenNatives.NativeFixer.GetAllVehicleModels();
-
+        MenuItem spawnByClassBtn = new MenuItem("Spawn Vehicle By Class", "Spawn a vehicle from a list of vehicle classes.") { Label = "→" };
+        Menu spawnByClassMenu = new Menu("Vehicle Spawner", "Spawn vehicles by class");
+        menu.AddMenuItem(spawnByClassBtn);
+        MenuController.AddSubmenu(menu, spawnByClassMenu);
+        MenuController.BindMenuItem(menu, spawnByClassMenu, spawnByClassBtn);
 
+        var vehicles = BrokenNatives.NativeFixer.GetAllVehicleModels();
 
         if (vehicles is null)
         {
-            return menu;
+            return;
         }
 
-        var vehicleSperCategory = vehicles
+        var vehiclesPerCategory = vehicles
             .Where(veh => !string.IsNullOrWhiteSpace(veh))
             .Select(veh => veh.Trim())
             .OrderBy(vehicle => vehicle)
-            .GroupBy(vehicle => Native.GetVehicleClassFromName(API.Hash(vehicle)));
+            .GroupBy(vehicle => Native.GetVehicleClassFromName(API.Hash(vehicle)))
+            .OrderBy(vehicle => Native.GetLabelText($"VEH_CLASS_{vehicle.Key}"));
 
-        foreach (var cat in vehicleSperCategory)
+        // These are the max speed, acceleration, braking and traction values per vehicle class.
+        var speedValues = new float[23]
+        {
+                44.9374657f,
+                50.0000038f,
+                48.862133f,
+                48.1321335f,
+                50.7077942f,
+                51.3333359f,
+                52.3922348f,
+                53.86687f,
+                52.03867f,
+                49.2241631f,
+                39.6176529f,
+                37.5559425f,
+                42.72843f,
+                21.0f,
+                45.0f,
+                65.1952744f,
+                109.764259f,
+                42.72843f,
+                56.5962219f,
+                57.5398865f,
+                43.3140678f,
+                26.66667f,
+                53.0537224f
+        };
+        var accelerationValues = new float[23]
+        {
+                0.34f,
+                0.29f,
+                0.335f,
+                0.28f,
+                0.395f,
+                0.39f,
+                0.66f,
+                0.42f,
+                0.425f,
+                0.475f,
+                0.21f,
+                0.3f,
+                0.32f,
+                0.17f,
+                18.0f,
+                5.88f,
+                21.0700016f,
+                0.33f,
+                14.0f,
+                6.86f,
+                0.32f,
+                0.2f,
+                0.76f
+        };
+        var brakingValues = new float[23]
+        {
+                0.72f,
+                0.95f,
+                0.85f,
+                0.9f,
+                1.0f,
+                1.0f,
+                1.3f,
+                1.25f,
+                1.52f,
+                1.1f,
+                0.6f,
+                0.7f,
+                0.8f,
+                3.0f,
+                0.4f,
+                3.5920403f,
+                20.58f,
+                0.9f,
+                2.93960738f,
+                3.9472363f,
+                0.85f,
+                5.0f,
+                1.3f
+        };
+        var tractionValues = new float[23]
         {
-            var submenu = new Menu("Class: " + cat.Key.ToString(), "Vehicle Spawner Menu");
+                2.3f,
+                2.55f,
+                2.3f,
+                2.6f,
+                2.625f,
+                2.65f,
+                2.8f,
+                2.782f,
+                2.9f,
+                2.95f,
+                2.0f,
+                3.3f,
+                2.175f,
+                2.05f,
+                0.0f,
+                1.6f,
+                2.15f,
+                2.55f,
+                2.57f,
+                3.7f,
+                2.05f,
+                2.5f,
+                3.2925f
+        };
+
+        foreach (var cat in vehiclesPerCategory)
+        {
+            var className = Native.GetLabelText($"VEH_CLASS_{cat.Key}");
+
+            var vehicleClassSubMenu = new Menu(className, "Vehicle Spawner Menu");
             foreach (var vehicle in cat)
             {
-                submenu.AddMenuItem(new MenuItem(vehicle));
+                var hash = API.Hash(vehicle);
+                var topSpeed = Map(Native.GetVehicleModelEstimatedMaxSpeed(hash), 0f, speedValues[cat.Key], 0f, 1f);
+                var acceleration = Map(Native.GetVehicleModelAcceleration(hash), 0f, accelerationValues[cat.Key], 0f, 1f);
+                var maxBraking = Map(Native.GetVehicleModelMaxBraking(hash), 0f, brakingValues[cat.Key], 0f, 1f);
+                var maxTraction = Map(Native.GetVehicleModelMaxTraction(hash), 0f, tractionValues[cat.Key], 0f, 1f);
+
+                var vehicleDisplayName = GetVehicleDisplayName(hash);
+                var vehicleSpawnButton = new MenuItem(vehicleDisplayName)
+                {
+                    Label = vehicle,
+                    ItemData = new float[4] { topSpeed, acceleration, maxBraking, maxTraction }
+                };
+
+                vehicleClassSubMenu.AddMenuItem(vehicleSpawnButton);
             }
 
-            submenu.OnItemSelect += Submenu_OnItemSelect;
-            MenuController.AddSubmenu(menu, submenu);
+            static void HandleStatsPanel(Menu openedMenu, MenuItem currentItem)
+            {
+                if (currentItem != null)
+                {
+                    if (currentItem.ItemData is float[] data)
+                    {
+                        openedMenu.ShowVehicleStatsPanel = true;
+                        openedMenu.SetVehicleStats(data[0], data[1], data[2], data[3]);
+                        openedMenu.SetVehicleUpgradeStats(0f, 0f, 0f, 0f);
+                    }
+                    else
+                    {
+                        openedMenu.ShowVehicleStatsPanel = false;
+                    }
+                }
+            }
+
+            vehicleClassSubMenu.OnMenuOpen += (m) =>
+            {
+                HandleStatsPanel(m, m.GetCurrentMenuItem());
+            };
+
+            vehicleClassSubMenu.OnIndexChange += (m, oldItem, newItem, oldIndex, newIndex) =>
+            {
+                HandleStatsPanel(m, newItem);
+            };
+
+            vehicleClassSubMenu.OnItemSelect += Submenu_OnItemSelect;
 
-            var btn = new MenuItem("Veh Class: " + cat.Key.ToString());
-            menu.AddMenuItem(btn);
+            var btn = new MenuItem(className, $"Spawn a vehicle from the ~y~{className}~s~ class.") { Label = $"({cat.Count()}) →" };
+            spawnByClassMenu.AddMenuItem(btn);
+            MenuController.AddSubmenu(spawnByClassMenu, vehicleClassSubMenu);
+            MenuController.BindMenuItem(spawnByClassMenu, vehicleClassSubMenu, btn);
+        }
+    }
 
-            MenuController.BindMenuItem(menu, submenu, btn);
-            API.Log.Info("Added submenu for vehicle class: {0}", cat.Key.ToString());
+    private static string GetVehicleDisplayName(uint hash)
+    {
+        var displayName = Native.GetDisplayNameFromVehicleModel(hash);
+        var labelText = Native.GetLabelText(displayName);
+        if (labelText == "NULL")
+        {
+            return _textInfo.ToTitleCase(displayName);
         }
 
-        return menu;
+        return _textInfo.ToTitleCase(labelText);
+    }
+
+    /// <summary>
+    /// Maps the <paramref name="value"/> (which is a value between <paramref name="min_in"/> and <paramref name="max_in"/>) to a new value in the range of <paramref name="min_out"/> and <paramref name="max_out"/>.
+    /// </summary>
+    /// <param name="value">The value to map.</param>
+    /// <param name="min_in">The minimum range value of the value.</param>
+    /// <param name="max_in">The max range value of the value.</param>
+    /// <param name="min_out">The min output range value.</param>
+    /// <param name="max_out">The max output range value.</param>
+    /// <returns></returns>
+    public static float Map(float value, float min_in, float max_in, float min_out, float max_out)
+    {
+        return ((value - min_in) * (max_out - min_out) / (max_in - min_in)) + min_out;
     }
 
 
     private async void Submenu_OnItemSelect(Menu menu, MenuItem menuItem, int itemIndex)
     {
-        var hash = API.Hash(menuItem.Text);
+        var hash = API.Hash(menuItem.Label);
 
         // Manually checking and requesting model because API.Vehicles.RequestAndCreate uses datetime which is currently broken and crashes the game.
         // https://github.com/citizenfx/rfc/discussions/328
@@ -79,10 +255,28 @@ private async void Submenu_OnItemSelect(Menu menu, MenuItem menuItem, int itemIn
             await API.Delay(0);
         }
 
-        var veh = await API.Vehicles.RequestAndCreate(hash, API.Players.Local.Ped!.Position, (int)API.Players.Local.Ped.Heading, true, true, true);
-        if (veh is not null)
+        var ped = API.Players.Local.Ped!;
+
+        var position = ped.Position;
+        if (ped.IsPedInAnyVehicle())
         {
-            API.Players.Local.Ped.SetPedIntoVehicle(veh!.Handle, -1);
+            var currentVehicle = ped.Vehicle!;
+
+            BrokenNatives.NativeFixer.GetModelDimensions(currentVehicle.Model, out var p1, out var p2);
+            BrokenNatives.NativeFixer.GetModelDimensions(hash, out var p3, out var p4);
+
+            var yOffset = (Math.Abs((p1 - p2).Y) / 2) + (Math.Abs((p3 - p4).Y) / 2) + 1f;
+            position = Native.GetOffsetFromEntityInWorldCoords(currentVehicle.Handle, 0f, yOffset, 0f);
         }
+        var newVehicle = await API.Vehicles.RequestAndCreate(hash, position, (int)ped.Heading, true, true, true);
+
+        Native.SetModelAsNoLongerNeeded(hash);
+
+        if (newVehicle is null)
+        {
+            return;
+        }
+
+        ped.SetPedIntoVehicle(newVehicle!.Handle, -1);
     }
 }