Merge pull request #533 from TomGrobbe/feature/serverEventRefactors

Server Event Refactors

Author: cm8263

SharedClasses/PermissionsManager.cs

@@ -28,6 +28,7 @@ public enum Permission
             OPTeleport,
             OPWaypoint,
             OPSpectate,
+            OPSendMessage,
             OPIdentifiers,
             OPSummon,
             OPKill,
@@ -385,9 +386,16 @@ public enum Permission
         /// </summary>
         /// <param name="permission"></param>
         /// <param name="source"></param>
-        /// <param name="checkAnyway">if true, then the permissions will be checked even if they aren't setup yet.</param>
         /// <returns></returns>
         public static bool IsAllowed(Permission permission, Player source) => IsAllowedServer(permission, source);
+
+        /// <summary>
+        /// Public function to check if a permission is allowed.
+        /// </summary>
+        /// <param name="permission"></param>
+        /// <param name="playerHandle"></param>
+        /// <returns></returns>
+        public static bool IsAllowed(Permission permission, string playerHandle) => IsAllowedServer(permission, playerHandle);
 #endif
 
 #if CLIENT
@@ -456,11 +464,23 @@ private static bool IsAllowedServer(Permission permission, Player source)
                 return false;
             }
 
-            if (IsPlayerAceAllowed(source.Handle, GetAceName(permission)))
+            return IsAllowedServer(permission, source.Handle);
+        }
+
+        /// <summary>
+        /// Checks if the player is allowed that specific permission.
+        /// </summary>
+        /// <param name="permission"></param>
+        /// <param name="playerHandle"></param>
+        /// <returns></returns>
+        private static bool IsAllowedServer(Permission permission, string playerHandle)
+        {
+            if (!DoesPlayerExist(playerHandle))
             {
-                return true;
+                return false;
             }
-            return false;
+
+            return IsPlayerAceAllowed(playerHandle, GetAceName(permission));
         }
 #endif
 

vMenu/CommonFunctions.cs

@@ -966,7 +966,13 @@ public static async void CommitSuicide()
         /// Summon player.
         /// </summary>
         /// <param name="player"></param>
-        public static void SummonPlayer(IPlayer player) => TriggerServerEvent("vMenu:SummonPlayer", player.ServerId);
+        public static void SummonPlayer(IPlayer player)
+        {
+            Vehicle currentVehicle = GetVehicle();
+            int numberOfSeats = currentVehicle is not null ? GetVehicleModelNumberOfSeats(currentVehicle.Model) : 0;
+
+            TriggerServerEvent("vMenu:SummonPlayer", player.ServerId, numberOfSeats);
+        }
         #endregion
 
         #region Spectate function
@@ -3293,10 +3299,6 @@ public static async void PrivateMessage(string source, string message, bool sent
 
             if (MainMenu.MiscSettingsMenu == null || MainMenu.MiscSettingsMenu.MiscDisablePrivateMessages)
             {
-                if (!(sent && source == Game.Player.ServerId.ToString()))
-                {
-                    TriggerServerEvent("vMenu:PmsDisabled", source);
-                }
                 return;
             }
 

vMenu/EventManager.cs

@@ -40,16 +40,14 @@ public EventManager()
             EventHandlers.Add("vMenu:SetAddons", new Action(SetConfigOptions)); // DEPRECATED: Backwards-compatible event handler; use 'vMenu:SetConfigOptions' instead
             EventHandlers.Add("vMenu:SetConfigOptions", new Action(SetConfigOptions));
             EventHandlers.Add("vMenu:SetPermissions", new Action<string>(MainMenu.SetPermissions));
-            EventHandlers.Add("vMenu:GoToPlayer", new Action<string>(SummonPlayer));
             EventHandlers.Add("vMenu:KillMe", new Action<string>(KillMe));
             EventHandlers.Add("vMenu:Notify", new Action<string>(NotifyPlayer));
             EventHandlers.Add("vMenu:SetClouds", new Action<float, string>(SetClouds));
             EventHandlers.Add("vMenu:GoodBye", new Action(GoodBye));
             EventHandlers.Add("vMenu:SetBanList", new Action<string>(UpdateBanList));
-            EventHandlers.Add("vMenu:ClearArea", new Action<float, float, float>(ClearAreaNearPos));
+            EventHandlers.Add("vMenu:ClearArea", new Action<Vector3>(ClearAreaNearPos));
             EventHandlers.Add("vMenu:updatePedDecors", new Action(UpdatePedDecors));
             EventHandlers.Add("playerSpawned", new Action(SetAppearanceOnFirstSpawn));
-            EventHandlers.Add("vMenu:GetOutOfCar", new Action<int, int>(GetOutOfCar));
             EventHandlers.Add("vMenu:PrivateMessage", new Action<string, string>(PrivateMessage));
             EventHandlers.Add("vMenu:UpdateTeleportLocations", new Action<string>(UpdateTeleportLocations));
 
@@ -353,92 +351,14 @@ private void KillMe(string sourceName)
             SetEntityHealth(Game.PlayerPed.Handle, 0);
         }
 
-        /// <summary>
-        /// Teleport to the specified player.
-        /// </summary>
-        /// <param name="targetPlayer"></param>
-        private async void SummonPlayer(string targetPlayer)
-        {
-            // ensure the player list is requested in case of Infinity
-            MainMenu.PlayersList.RequestPlayerList();
-            await MainMenu.PlayersList.WaitRequested();
-
-            var player = MainMenu.PlayersList.FirstOrDefault(a => a.ServerId == int.Parse(targetPlayer));
-
-            if (player != null)
-            {
-                _ = TeleportToPlayer(player);
-            }
-        }
-
         /// <summary>
         /// Clear the area around the provided x, y, z coordinates. Clears everything like (destroyed) objects, peds, (ai) vehicles, etc.
         /// Also restores broken streetlights, etc.
         /// </summary>
         /// <param name="x"></param>
         /// <param name="y"></param>
         /// <param name="z"></param>
-        private void ClearAreaNearPos(float x, float y, float z)
-        {
-            ClearAreaOfEverything(x, y, z, 100f, false, false, false, false);
-        }
-
-        /// <summary>
-        /// Kicks the current player from the specified vehicle if they're inside and don't own the vehicle themselves.
-        /// </summary>
-        /// <param name="vehNetId"></param>
-        /// <param name="vehicleOwnedBy"></param>
-        private async void GetOutOfCar(int vehNetId, int vehicleOwnedBy)
-        {
-            if (NetworkDoesNetworkIdExist(vehNetId))
-            {
-                var veh = NetToVeh(vehNetId);
-                if (DoesEntityExist(veh))
-                {
-                    var vehicle = new Vehicle(veh);
-
-                    if (vehicle == null || !vehicle.Exists())
-                    {
-                        return;
-                    }
-
-                    if (Game.PlayerPed.IsInVehicle(vehicle) && vehicleOwnedBy != Game.Player.ServerId)
-                    {
-                        if (!vehicle.IsStopped)
-                        {
-                            Notify.Alert("The owner of this vehicle is reclaiming their personal vehicle. You will be kicked from this vehicle in about 10 seconds. Stop the vehicle now to avoid taking damage.", false, true);
-                        }
-
-                        // Wait for the vehicle to come to a stop, or 10 seconds, whichever is faster.
-                        var timer = GetGameTimer();
-                        while (vehicle != null && vehicle.Exists() && !vehicle.IsStopped)
-                        {
-                            await Delay(0);
-                            if (GetGameTimer() - timer > (10 * 1000)) // 10 second timeout
-                            {
-                                break;
-                            }
-                        }
-
-                        // just to make sure they're actually still inside the vehicle and the vehicle still exists.
-                        if (vehicle != null && vehicle.Exists() && Game.PlayerPed.IsInVehicle(vehicle))
-                        {
-                            // Make the ped jump out because the car isn't stopped yet.
-                            if (!vehicle.IsStopped)
-                            {
-                                Notify.Info("You were warned, now you'll have to suffer the consequences!");
-                                TaskLeaveVehicle(Game.PlayerPed.Handle, vehicle.Handle, 4160);
-                            }
-                            // Make the ped exit gently.
-                            else
-                            {
-                                TaskLeaveVehicle(Game.PlayerPed.Handle, vehicle.Handle, 0);
-                            }
-                        }
-                    }
-                }
-            }
-        }
+        private void ClearAreaNearPos(Vector3 position) => ClearAreaOfEverything(position.X, position.Y, position.Z, 100f, false, false, false, false);
 
         /// <summary>
         /// Updates ped decorators for the clothing animation when players have joined.

vMenu/MainMenu.cs

@@ -120,7 +120,7 @@ public MainMenu()
             }
             #endregion
             #region keymapping
-            string KeyMappingID = String.IsNullOrWhiteSpace(GetSettingsString(Setting.vmenu_keymapping_id)) ? "Default" : GetSettingsString(Setting.vmenu_keymapping_id);
+            string KeyMappingID = GetKeyMappingId();
             RegisterCommand($"vMenu:{KeyMappingID}:NoClip", new Action<dynamic, List<dynamic>, string>((dynamic source, List<dynamic> args, string rawCommand) =>
             {
                 if (IsAllowed(Permission.NoClip))
@@ -144,20 +144,6 @@ public MainMenu()
                     }
                 }
             }), false);
-            RegisterCommand($"vMenu:{KeyMappingID}:MenuToggle", new Action<dynamic, List<dynamic>, string>((dynamic source, List<dynamic> args, string rawCommand) =>
-            {
-                if (MenuEnabled)
-                {
-                    if (!MenuController.IsAnyMenuOpen())
-                    {
-                        Menu.OpenMenu();
-                    }
-                    else
-                    {
-                        MenuController.CloseAllMenus();
-                    }
-                }
-            }), false);
 
             if (!(GetSettingsString(Setting.vmenu_noclip_toggle_key) == null))
             {
@@ -340,29 +326,13 @@ public MainMenu()
             // Clear all previous pause menu info/brief messages on resource start.
             ClearBrief();
 
-            // Request the permissions data from the server.
-            TriggerServerEvent("vMenu:RequestPermissions");
-
-            // Request server state from the server.
-            TriggerServerEvent("vMenu:RequestServerState");
-        }
-
-        #region Infinity bits
-        [EventHandler("vMenu:SetServerState")]
-        public void SetServerState(IDictionary<string, object> data)
-        {
-            if (data.TryGetValue("IsInfinity", out var isInfinity))
+            if (GlobalState.Get("vmenu_onesync") ?? false)
             {
-                if (isInfinity is bool isInfinityBool)
-                {
-                    if (isInfinityBool)
-                    {
-                        PlayersList = new InfinityPlayerList(Players);
-                    }
-                }
+                PlayersList = new InfinityPlayerList(Players);
             }
         }
 
+        #region Infinity bits
         [EventHandler("vMenu:ReceivePlayerList")]
         public void ReceivedPlayerList(IList<object> players)
         {
@@ -540,6 +510,21 @@ static bool canUseMenu()
                 StatSetFloat((uint)GetHashKey("MP0_PLAYER_MENTAL_STATE"), 0f, true);    // Mental State
             }
 
+            RegisterCommand($"vMenu:{GetKeyMappingId()}:MenuToggle", new Action<dynamic, List<dynamic>, string>((dynamic source, List<dynamic> args, string rawCommand) =>
+            {
+                if (MenuEnabled)
+                {
+                    if (!MenuController.IsAnyMenuOpen())
+                    {
+                        Menu.OpenMenu();
+                    }
+                    else
+                    {
+                        MenuController.CloseAllMenus();
+                    }
+                }
+            }), false);
+
             TriggerEvent("vMenu:SetupTickFunctions");
         }
 
@@ -920,5 +905,9 @@ private static void CreateSubmenus()
             }
         }
         #endregion
+
+        #region Utilities
+        private static string GetKeyMappingId() => string.IsNullOrWhiteSpace(GetSettingsString(Setting.vmenu_keymapping_id)) ? "Default" : GetSettingsString(Setting.vmenu_keymapping_id);
+        #endregion
     }
 }

vMenu/menus/MiscSettings.cs

@@ -50,7 +50,16 @@ public class MiscSettings
         public bool RestorePlayerWeapons { get; private set; } = UserDefaults.MiscRestorePlayerWeapons;
         public bool DrawTimeOnScreen { get; internal set; } = UserDefaults.MiscShowTime;
         public bool MiscRightAlignMenu { get; private set; } = UserDefaults.MiscRightAlignMenu;
-        public bool MiscDisablePrivateMessages { get; private set; } = UserDefaults.MiscDisablePrivateMessages;
+        private bool _disablePrivateMessages;
+        public bool MiscDisablePrivateMessages
+        {
+            get => _disablePrivateMessages;
+            set
+            {
+                _disablePrivateMessages = value;
+                Game.Player.State.Set("vmenu_pms_disabled", value, true);
+            }
+        }
         public bool MiscDisableControllerSupport { get; private set; } = UserDefaults.MiscDisableControllerSupport;
 
         internal bool TimecycleEnabled { get; private set; } = false;
@@ -70,6 +79,12 @@ public class MiscSettings
 
         internal static List<vMenuShared.ConfigManager.TeleportLocation> TpLocations = new();
 
+        public MiscSettings()
+        {
+            // Sets statebag when resource starts
+            MiscDisablePrivateMessages = UserDefaults.MiscDisablePrivateMessages;
+        }
+
         /// <summary>
         /// Creates the menu.
         /// </summary>
@@ -469,8 +484,7 @@ private void CreateMenu()
             {
                 if (item == clearArea)
                 {
-                    var pos = Game.PlayerPed.Position;
-                    BaseScript.TriggerServerEvent("vMenu:ClearArea", pos.X, pos.Y, pos.Z);
+                    BaseScript.TriggerServerEvent("vMenu:ClearArea");
                 }
             };
 

vMenu/menus/OnlinePlayers.cs

@@ -52,9 +52,10 @@ private void CreateMenu()
             var ban = new MenuItem("~r~Ban Player Permanently", "Ban this player permanently from the server. Are you sure you want to do this? You can specify the ban reason after clicking this button.");
             var tempban = new MenuItem("~r~Ban Player Temporarily", "Give this player a tempban of up to 30 days (max). You can specify duration and ban reason after clicking this button.");
 
-            // always allowed
-            playerMenu.AddMenuItem(sendMessage);
-            // permissions specific
+            if (IsAllowed(Permission.OPSendMessage))
+            {
+                playerMenu.AddMenuItem(sendMessage);
+            }
             if (IsAllowed(Permission.OPTeleport))
             {
                 playerMenu.AddMenuItem(teleport);
@@ -111,6 +112,12 @@ private void CreateMenu()
                 // send message
                 if (item == sendMessage)
                 {
+                    if (currentPlayer.Handle == Game.Player.Handle)
+                    {
+                        Notify.Error("You cannot message yourself!");
+                        return;
+                    }
+
                     if (MainMenu.MiscSettingsMenu != null && !MainMenu.MiscSettingsMenu.MiscDisablePrivateMessages)
                     {
                         var message = await GetUserInput($"Private Message To {currentPlayer.Name}", 200);
@@ -245,6 +252,7 @@ private void CreateMenu()
                 }
                 else if (item == printIdentifiers)
                 {
+                    // TODO: Replace callback function
                     Func<string, string> CallbackFunction = (data) =>
                     {
                         Debug.WriteLine(data);

vMenu/menus/PersonalVehicle.cs

@@ -280,10 +280,11 @@ private void CreateMenu()
                 {
                     if (item == kickAllPassengers)
                     {
-                        if (CurrentPersonalVehicle.Occupants.Count() > 0 && CurrentPersonalVehicle.Occupants.Any(p => p != Game.PlayerPed))
+                        Ped[] occupants = CurrentPersonalVehicle.Occupants;
+
+                        if (occupants.Count() > 0 && occupants.Any(p => p != Game.PlayerPed && p.IsPlayer))
                         {
-                            var netId = VehToNet(CurrentPersonalVehicle.Handle);
-                            TriggerServerEvent("vMenu:GetOutOfCar", netId, Game.Player.ServerId);
+                            TriggerServerEvent("vMenu:GetOutOfCar", CurrentPersonalVehicle.NetworkId);
                         }
                         else
                         {

vMenu/menus/WeatherOptions.cs

@@ -143,6 +143,12 @@ private void CreateMenu()
                 }
                 else if (item == snowEnabled)
                 {
+                    if (EventManager.GetServerWeather is "XMAS" or "SNOWLIGHT" or "SNOW" or "BLIZZARD")
+                    {
+                        Notify.Custom($"Snow effects cannot be disabled when weather is ~y~{EventManager.GetServerWeather}~s~.");
+                        return;
+                    }
+
                     Notify.Custom($"Snow effects will now be forced {(_checked ? "~g~enabled" : "~r~disabled")}~s~.");
                     UpdateServerWeather(EventManager.GetServerWeather, EventManager.DynamicWeatherEnabled, _checked);
                 }