fix(online players): tell the summoner when the player is already next to them or in their vehicle

Author: TomGrobbe

assets/enhanced/language/de.json

@@ -876,6 +876,7 @@
     "onlineplayers.summon.by": "Du wurdest von ~y~{player}~s~ herbeigerufen.",
     "onlineplayers.summon.desc": "Holt diesen Spieler dorthin, wo du stehst.",
     "onlineplayers.summon.done": "~g~{player}~s~ herbeigerufen.",
+    "onlineplayers.summon.nearby": "~y~{player}~s~ steht schon direkt neben dir.",
     "onlineplayers.summon.riding": "~y~{player}~s~ sitzt schon in deinem Fahrzeug.",
     "onlineplayers.summonvehicle": "Spieler ins Fahrzeug holen",
     "onlineplayers.summonvehicle.by": "Du wurdest ins Fahrzeug von ~y~{player}~s~ geholt.",

assets/enhanced/language/es.json

@@ -876,6 +876,7 @@
     "onlineplayers.summon.by": "~y~{player}~s~ te ha traído hasta él.",
     "onlineplayers.summon.desc": "Trae a este jugador hasta donde estás.",
     "onlineplayers.summon.done": "Has traído a ~g~{player}~s~.",
+    "onlineplayers.summon.nearby": "~y~{player}~s~ ya está justo a tu lado.",
     "onlineplayers.summon.riding": "~y~{player}~s~ ya está en tu vehículo.",
     "onlineplayers.summonvehicle": "Traer jugador al vehículo",
     "onlineplayers.summonvehicle.by": "~y~{player}~s~ te ha traído a su vehículo.",

assets/enhanced/language/fr.json

@@ -876,6 +876,7 @@
     "onlineplayers.summon.by": "Vous avez été amené par ~y~{player}~s~.",
     "onlineplayers.summon.desc": "Amène ce joueur là où vous vous trouvez.",
     "onlineplayers.summon.done": "~g~{player}~s~ a été amené.",
+    "onlineplayers.summon.nearby": "~y~{player}~s~ se tient déjà juste à côté de vous.",
     "onlineplayers.summon.riding": "~y~{player}~s~ est déjà dans votre véhicule.",
     "onlineplayers.summonvehicle": "Faire venir le joueur dans le véhicule",
     "onlineplayers.summonvehicle.by": "Vous avez été amené dans le véhicule de ~y~{player}~s~.",

assets/enhanced/language/nl.json

@@ -876,6 +876,7 @@
     "onlineplayers.summon.by": "Je bent opgeroepen door ~y~{player}~s~.",
     "onlineplayers.summon.desc": "Haalt deze speler naar de plek waar jij staat.",
     "onlineplayers.summon.done": "~g~{player}~s~ opgeroepen.",
+    "onlineplayers.summon.nearby": "~y~{player}~s~ staat al vlak naast je.",
     "onlineplayers.summon.riding": "~y~{player}~s~ zit al in je voertuig.",
     "onlineplayers.summonvehicle": "Speler in voertuig oproepen",
     "onlineplayers.summonvehicle.by": "Je bent in het voertuig van ~y~{player}~s~ geplaatst.",

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

@@ -1,4 +1,4 @@
-namespace vMenu.Enhanced.MenuFramework.Localization.Languages;
+namespace vMenu.Enhanced.MenuFramework.Localization.Languages;
 
 /// <summary>The English strings, and the fallback for every other language.</summary>
 /// <remarks>Every other language lives in a JSON file under <c>assets/enhanced/language/</c>. If you
@@ -373,6 +373,7 @@ internal static class EnglishStrings
             [Loc.OnlinePlayers.SummonDescription] = "Bring this player to where you are standing.",
             [Loc.OnlinePlayers.SummonDone] = "Summoned ~g~{player}~s~.",
             [Loc.OnlinePlayers.SummonedBy] = "You have been summoned by ~y~{player}~s~.",
+            [Loc.OnlinePlayers.SummonNearby] = "~y~{player}~s~ is already standing right next to you.",
             [Loc.OnlinePlayers.SummonRiding] = "~y~{player}~s~ is already in your vehicle.",
             [Loc.OnlinePlayers.SummonIntoVehicle] = "Summon Player Into Vehicle",
             [Loc.OnlinePlayers.SummonIntoVehicleDescription] = "Bring this player straight into a free seat of the vehicle you are in. Nothing happens if you are not in a vehicle, or if every seat is taken.",

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

@@ -64,6 +64,8 @@ public static class OnlinePlayers
 
         public const string SummonedBy = "onlineplayers.summon.by";
 
+        public const string SummonNearby = "onlineplayers.summon.nearby";
+
         public const string SummonRiding = "onlineplayers.summon.riding";
 
         public const string SummonIntoVehicle = "onlineplayers.summonvehicle";

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

@@ -46,6 +46,8 @@ public sealed class OnlinePlayersMenu : MenuDefinition
 
     private const string SummonMoved = "0";
 
+    private const string SummonNearby = "1";
+
     private const string SummonRiding = "2";
 
     private const string SummonNoVehicle = "3";
@@ -330,7 +332,7 @@ private void BuildActions(MenuBuilder actions)
             Text = MenuText.Key(Loc.OnlinePlayers.Summon),
             Description = MenuText.Key(Loc.OnlinePlayers.SummonDescription),
             Gate = OnlinePlayersPermissions.Summon,
-            OnSelectedAsync = _ => SendAsync(ActionIds.OnlinePlayers.Summon, Loc.OnlinePlayers.SummonDone, allowSelf: false),
+            OnSelectedAsync = _ => SummonAsync(),
         });
 
         actions.Entries.Add(new ButtonEntry
@@ -787,6 +789,43 @@ private async Task TeleportIntoVehicleAsync()
         Notifications.Success(MenuText.Key(Loc.OnlinePlayers.TeleportIntoVehicleDone, ("player", name)));
     }
 
+    private async Task SummonAsync()
+    {
+        if (Target() is not { } player)
+        {
+            return;
+        }
+
+        var name = MenuText.Literal(player.Name);
+
+        var result = await ServerActions.InvokeAsync(ActionIds.OnlinePlayers.Summon, Id(player));
+
+        if (result.Status != ActionStatus.Ok || result.Data.Length < 1)
+        {
+            Report(result, name);
+
+            return;
+        }
+
+        switch (result.Data[0])
+        {
+            case SummonNearby:
+                Notifications.Info(MenuText.Key(Loc.OnlinePlayers.SummonNearby, ("player", name)));
+
+                break;
+
+            case SummonRiding:
+                Notifications.Info(MenuText.Key(Loc.OnlinePlayers.SummonRiding, ("player", name)));
+
+                break;
+
+            default:
+                Notifications.Success(MenuText.Key(Loc.OnlinePlayers.SummonDone, ("player", name)));
+
+                break;
+        }
+    }
+
     private async Task SummonIntoVehicleAsync()
     {
         if (Target() is not { } player)

src/Server/vMenu.Enhanced.Actions.Server/Handlers/OnlinePlayerActions.cs

@@ -1,4 +1,5 @@
 using System.Globalization;
+using System.Numerics;
 
 using CitizenFX.FiveM.Server;
 using CitizenFX.FiveM.Server.Entities;
@@ -57,10 +58,14 @@ public static class OnlinePlayerActions
 
     private const string StatusUnknown = "?";
 
+    private const float NearbyDistance = 5f;
+
     private const int MaxSeat = 16;
 
     private const string SummonMoved = "0";
 
+    private const string SummonNearby = "1";
+
     private const string SummonRiding = "2";
 
     private const string SummonNoVehicle = "3";
@@ -582,20 +587,28 @@ private static ActionResponse Summon(Player source, string[] args)
 
         // Somebody still on the loading screen has no character to move, and their client is not listening
         // for this yet either.
-        if (PedOf(target) is null)
+        if (PedOf(target) is not { } targetPed)
         {
             return ActionResponse.NotReady();
         }
 
-        var ped = source.PedIndex;
-
-        if (ped <= 0 || !Native.DoesEntityExist(ped))
+        if (SourcePedOf(source) is not { } ped)
         {
             return ActionResponse.NotFound();
         }
 
+        if (SharesVehicle(ped, targetPed))
+        {
+            return ActionResponse.Ok(SummonRiding);
+        }
+
         var coords = Native.GetEntityCoords(ped);
 
+        if (IsNearby(coords, Native.GetEntityCoords(targetPed)))
+        {
+            return ActionResponse.Ok(SummonNearby);
+        }
+
         MatchBucket(target, source.Handle);
 
         Log.Info($"[OnlinePlayers] {source.Name} summoned {Native.GetPlayerName(target.ToString())}.");
@@ -610,7 +623,7 @@ private static ActionResponse Summon(Player source, string[] args)
             coords.Y.ToString(CultureInfo.InvariantCulture),
             coords.Z.ToString(CultureInfo.InvariantCulture));
 
-        return ActionResponse.Ok();
+        return ActionResponse.Ok(SummonMoved);
     }
 
     private static ActionResponse SummonIntoVehicle(Player source, string[] args)
@@ -686,6 +699,16 @@ private static ActionResponse SummonIntoVehicle(Player source, string[] args)
         return ped > 0 && Native.DoesEntityExist(ped) ? ped : null;
     }
 
+    private static bool SharesVehicle(int ped, int other)
+    {
+        var vehicle = Native.GetVehiclePedIsIn(ped, false);
+
+        return vehicle != 0 && Native.DoesEntityExist(vehicle) && Native.GetVehiclePedIsIn(other, false) == vehicle;
+    }
+
+    private static bool IsNearby(Vector3 from, Vector3 to) =>
+        Vector3.DistanceSquared(from, to) <= NearbyDistance * NearbyDistance;
+
     // The sender is not answered until the other player's client says it put the message on screen.
     // "Sent" when the other end never showed it is the one thing a sender actually wants to know.
     private static async Task<ActionResponse> SendMessage(Player source, string[] args)