diff --git a/CHANGELOG.md b/CHANGELOG.md index 3d902451..7286ea27 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -56,6 +56,7 @@ This is the rolling changelog for TShock for Terraria. Use past tense when addin * Added `TSPlayer` to `GetDataHandlers.GemLockToggle`. (@hakusaro) * Added `GetDataHandlers.PlaceItemFrame` hook and related arguments. (@hakusaro) * Added `TSPlayer.IsBouncerThrottled()`. (@hakusaro) +* Added `TSPlayer.IsBeingDisabled()` and removed `TShock.CheckIgnores(TSPlayer)`. (@hakusaro) * Added `TSPlayer.CheckIgnores()` and removed `TShock.CheckIgnores(TSPlayer)`. (@hakusaro) * Hooks inside TShock can now be registered with their `Register` method and can be prioritized according to the TShock HandlerList system. (@hakusaro) * Fix message requiring login not using the command specifier set in the config file. (@hakusaro) diff --git a/TShockAPI/Bouncer.cs b/TShockAPI/Bouncer.cs index 01cff94b..8e81d802 100644 --- a/TShockAPI/Bouncer.cs +++ b/TShockAPI/Bouncer.cs @@ -69,7 +69,7 @@ namespace TShockAPI /// The packet arguments that the event has. internal void OnPlaceItemFrame(object sender, GetDataHandlers.PlaceItemFrameEventArgs args) { - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { NetMessage.SendData((int)PacketTypes.UpdateTileEntity, -1, -1, NetworkText.Empty, args.ItemFrame.ID, 0, 1); args.Handled = true; @@ -108,7 +108,7 @@ namespace TShockAPI return; } - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Handled = true; return; @@ -126,7 +126,7 @@ namespace TShockAPI /// The packet arguments that the event has. internal void OnPlaceTileEntity(object sender, GetDataHandlers.PlaceTileEntityEventArgs args) { - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Handled = true; return; @@ -177,7 +177,7 @@ namespace TShockAPI return; } - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Handled = true; return; @@ -196,7 +196,7 @@ namespace TShockAPI /// args internal void OnPlayerAnimation(object sender, GetDataHandlers.PlayerAnimationEventArgs args) { - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Player.SendData(PacketTypes.PlayerAnimation, "", args.Player.Index); args.Handled = true; @@ -245,7 +245,7 @@ namespace TShockAPI return; } - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Player.SendData(PacketTypes.NpcUpdate, "", id); args.Handled = true; @@ -311,7 +311,7 @@ namespace TShockAPI return; } - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Player.SendData(PacketTypes.PlayerHp, "", id); args.Player.SendData(PacketTypes.PlayerUpdate, "", id); @@ -421,7 +421,7 @@ namespace TShockAPI } - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Player.SendData(PacketTypes.ItemDrop, "", id); args.Handled = true; @@ -444,7 +444,7 @@ namespace TShockAPI return; } - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Player.SendData(PacketTypes.PlayerAddBuff, "", id); args.Handled = true; @@ -503,7 +503,7 @@ namespace TShockAPI return; } - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Player.SendData(PacketTypes.ChestItem, "", id, slot); args.Handled = true; @@ -558,7 +558,7 @@ namespace TShockAPI /// The packet arguments that the event has. internal void OnChestOpen(object sender, GetDataHandlers.ChestOpenEventArgs args) { - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Handled = true; return; @@ -595,7 +595,7 @@ namespace TShockAPI return; } - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Player.SendTileSquare(tileX, tileY, 3); args.Handled = true; @@ -656,7 +656,7 @@ namespace TShockAPI return; } - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Player.SendTileSquare(tileX, tileY, 1); args.Handled = true; @@ -791,7 +791,7 @@ namespace TShockAPI return; } - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Player.RemoveProjectile(args.ProjectileIdentity, args.ProjectileOwner); args.Handled = true; @@ -841,29 +841,29 @@ namespace TShockAPI float distance = Vector2.Distance(new Vector2(pos.X / 16f, pos.Y / 16f), new Vector2(args.Player.LastNetPosition.X / 16f, args.Player.LastNetPosition.Y / 16f)); - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { // If the player has moved outside the disabled zone... if (distance > TShock.Config.MaxRangeForDisabled) { // We need to tell them they were disabled and why, then revert the change. - if (args.Player.IgnoreActionsForCheating != "none") + if (args.Player.IsDisabledForStackDetection) { - args.Player.SendErrorMessage("Disabled for cheating: " + args.Player.IgnoreActionsForCheating); + args.Player.SendErrorMessage("Disabled. You went too far with hacked item stacks."); } - else if (args.Player.IgnoreActionsForDisabledArmor != "none") + else if (args.Player.IsDisabledForBannedWearable) { - args.Player.SendErrorMessage("Disabled for banned armor: " + args.Player.IgnoreActionsForDisabledArmor); + args.Player.SendErrorMessage("Disabled. You went too far with banned armor."); } - else if (args.Player.IgnoreActionsForInventory != "none") + else if (args.Player.IsDisabledForSSC) { - args.Player.SendErrorMessage("Disabled for Server Side Inventory: " + args.Player.IgnoreActionsForInventory); + args.Player.SendErrorMessage("Disabled. You need to {0}login to load your saved data.", TShock.Config.CommandSpecifier); } else if (TShock.Config.RequireLogin && !args.Player.IsLoggedIn) { args.Player.SendErrorMessage("Account needed! Please {0}register or {0}login to play!", TShock.Config.CommandSpecifier); } - else if (args.Player.IgnoreActionsForClearingTrashCan) + else if (args.Player.IsDisabledPendingTrashRemoval) { args.Player.SendErrorMessage("You need to rejoin to ensure your trash can is cleared!"); } @@ -982,7 +982,7 @@ namespace TShockAPI return; } - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Player.RemoveProjectile(ident, owner); args.Handled = true; @@ -1115,7 +1115,7 @@ namespace TShockAPI return; } - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Player.SendTileSquare(x, y, 4); args.Handled = true; @@ -1470,7 +1470,7 @@ namespace TShockAPI return; } - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Player.SendTileSquare(tileX, tileY, 4); args.Handled = true; @@ -1586,7 +1586,7 @@ namespace TShockAPI return; } - if (args.Player.CheckIgnores() || args.Player.IsBouncerThrottled()) + if (args.Player.IsBeingDisabled() || args.Player.IsBouncerThrottled()) { args.Handled = true; return; @@ -1627,7 +1627,7 @@ namespace TShockAPI return; } - if (args.Player.CheckIgnores()) + if (args.Player.IsBeingDisabled()) { args.Player.SendTileSquare(tileX, tileY, size); args.Handled = true; diff --git a/TShockAPI/Commands.cs b/TShockAPI/Commands.cs index 79ed00c4..542d3367 100644 --- a/TShockAPI/Commands.cs +++ b/TShockAPI/Commands.cs @@ -848,7 +848,7 @@ namespace TShockAPI args.Player.tempGroup = null; args.Player.Account = account; args.Player.IsLoggedIn = true; - args.Player.IgnoreActionsForInventory = "none"; + args.Player.IsDisabledForSSC = false; if (Main.ServerSideCharacter) { @@ -862,10 +862,10 @@ namespace TShockAPI args.Player.LoginFailsBySsi = false; if (args.Player.HasPermission(Permissions.ignorestackhackdetection)) - args.Player.IgnoreActionsForCheating = "none"; + args.Player.IsDisabledForStackDetection = false; if (args.Player.HasPermission(Permissions.usebanneditem)) - args.Player.IgnoreActionsForDisabledArmor = "none"; + args.Player.IsDisabledForBannedWearable = false; args.Player.SendSuccessMessage("Authenticated as " + account.Name + " successfully."); @@ -1636,7 +1636,7 @@ namespace TShockAPI args.Player.SendSuccessMessage("SSC has been saved."); foreach (TSPlayer player in TShock.Players) { - if (player != null && player.IsLoggedIn && !player.IgnoreActionsForClearingTrashCan) + if (player != null && player.IsLoggedIn && !player.IsDisabledPendingTrashRemoval) { TShock.CharacterDB.InsertPlayerData(player, true); } @@ -1681,7 +1681,7 @@ namespace TShockAPI args.Player.SendErrorMessage("Player \"{0}\" has to perform a /login attempt first.", matchedPlayer.Name); return; } - if (matchedPlayer.IgnoreActionsForClearingTrashCan) + if (matchedPlayer.IsDisabledPendingTrashRemoval) { args.Player.SendErrorMessage("Player \"{0}\" has to reconnect first.", matchedPlayer.Name); return; @@ -1887,7 +1887,7 @@ namespace TShockAPI { foreach (TSPlayer player in TShock.Players) { - if (player != null && player.IsLoggedIn && !player.IgnoreActionsForClearingTrashCan) + if (player != null && player.IsLoggedIn && !player.IsDisabledPendingTrashRemoval) { player.SaveServerCharacter(); } diff --git a/TShockAPI/GetDataHandlers.cs b/TShockAPI/GetDataHandlers.cs index d8eb344d..1f0002c4 100644 --- a/TShockAPI/GetDataHandlers.cs +++ b/TShockAPI/GetDataHandlers.cs @@ -1612,7 +1612,7 @@ namespace TShockAPI args.Player.HasSentInventory && !args.Player.HasPermission(Permissions.bypassssc)) { // The player might have moved an item to their trash can before they performed a single login attempt yet. - args.Player.IgnoreActionsForClearingTrashCan = true; + args.Player.IsDisabledPendingTrashRemoval = true; } if (slot == 58) //this is the hand @@ -1784,7 +1784,7 @@ namespace TShockAPI args.Player.tempGroup = null; args.Player.Account = account; args.Player.IsLoggedIn = true; - args.Player.IgnoreActionsForInventory = "none"; + args.Player.IsDisabledForSSC = false; if (Main.ServerSideCharacter) { @@ -1798,10 +1798,10 @@ namespace TShockAPI args.Player.LoginFailsBySsi = false; if (args.Player.HasPermission(Permissions.ignorestackhackdetection)) - args.Player.IgnoreActionsForCheating = "none"; + args.Player.IsDisabledForStackDetection = false; if (args.Player.HasPermission(Permissions.usebanneditem)) - args.Player.IgnoreActionsForDisabledArmor = "none"; + args.Player.IsDisabledForBannedWearable = false; args.Player.SendSuccessMessage("Authenticated as " + account.Name + " successfully."); TShock.Log.ConsoleInfo(args.Player.Name + " authenticated successfully as user " + args.Player.Name + "."); @@ -1856,7 +1856,7 @@ namespace TShockAPI args.Player.tempGroup = null; args.Player.Account = account; args.Player.IsLoggedIn = true; - args.Player.IgnoreActionsForInventory = "none"; + args.Player.IsDisabledForSSC = false; if (Main.ServerSideCharacter) { @@ -1870,10 +1870,10 @@ namespace TShockAPI args.Player.LoginFailsBySsi = false; if (args.Player.HasPermission(Permissions.ignorestackhackdetection)) - args.Player.IgnoreActionsForCheating = "none"; + args.Player.IsDisabledForStackDetection = false; if (args.Player.HasPermission(Permissions.usebanneditem)) - args.Player.IgnoreActionsForDisabledArmor = "none"; + args.Player.IsDisabledForBannedWearable = false; args.Player.SendMessage("Authenticated as " + args.Player.Name + " successfully.", Color.LimeGreen); diff --git a/TShockAPI/TSPlayer.cs b/TShockAPI/TSPlayer.cs index fcc29b04..5b1c59a7 100644 --- a/TShockAPI/TSPlayer.cs +++ b/TShockAPI/TSPlayer.cs @@ -277,13 +277,17 @@ namespace TShockAPI private string CacheIP; - public string IgnoreActionsForInventory = "none"; + /// Determines if the player is disabled by the SSC subsystem for not being logged in. + public bool IsDisabledForSSC = false; - public string IgnoreActionsForCheating = "none"; + /// Determines if the player is disabled by Bouncer for having hacked item stacks. + public bool IsDisabledForStackDetection = false; - public string IgnoreActionsForDisabledArmor = "none"; + /// Determines if the player is disabled by the item bans system for having banned wearables on the server. + public bool IsDisabledForBannedWearable = false; - public bool IgnoreActionsForClearingTrashCan; + /// Determines if the player is disabled for not clearing their trash. A re-login is the only way to reset this. + public bool IsDisabledPendingTrashRemoval; /// Checks to see if active throttling is happening on events by Bouncer. Rejects repeated events by malicious clients in a short window. /// If the player is currently being throttled by Bouncer, or not. @@ -292,12 +296,15 @@ namespace TShockAPI return (DateTime.UtcNow - LastThreat).TotalMilliseconds < 5000; } - /// CheckIgnores - Checks a players ignores...? - /// player - The TSPlayer object. - /// bool - True if any ignore is not none, false, or login state differs from the required state. - public bool CheckIgnores() + /// Easy check if a player has any of IsDisabledForSSC, IsDisabledForStackDetection, IsDisabledForBannedWearable, or IsDisabledPendingTrashRemoval set. Or if they're not logged in and a login is required. + /// If any of the checks that warrant disabling are set on this player. If true, Disable() is repeatedly called on them. + public bool IsBeingDisabled() { - return IgnoreActionsForInventory != "none" || IgnoreActionsForCheating != "none" || IgnoreActionsForDisabledArmor != "none" || IgnoreActionsForClearingTrashCan || !IsLoggedIn && TShock.Config.RequireLogin; + return IsDisabledForSSC + || IsDisabledForStackDetection + || IsDisabledForBannedWearable + || IsDisabledPendingTrashRemoval + || !IsLoggedIn && TShock.Config.RequireLogin; } /// Checks to see if a player has hacked item stacks in their inventory, and messages them as it checks. @@ -862,8 +869,8 @@ namespace TShockAPI PlayerHooks.OnPlayerLogout(this); if (Main.ServerSideCharacter) { - IgnoreActionsForInventory = $"Server side characters is enabled! Please {Commands.Specifier}register or {Commands.Specifier}login to play!"; - if (!IgnoreActionsForClearingTrashCan && (!Dead || TPlayer.difficulty != 2)) + IsDisabledForSSC = true; + if (!IsDisabledPendingTrashRemoval && (!Dead || TPlayer.difficulty != 2)) { PlayerData.CopyCharacter(this); TShock.CharacterDB.InsertPlayerData(this); diff --git a/TShockAPI/TShock.cs b/TShockAPI/TShock.cs index 503e8d01..b5f758bc 100644 --- a/TShockAPI/TShock.cs +++ b/TShockAPI/TShock.cs @@ -945,7 +945,7 @@ namespace TShockAPI foreach (TSPlayer player in Players) { // prevent null point exceptions - if (player != null && player.IsLoggedIn && !player.IgnoreActionsForClearingTrashCan) + if (player != null && player.IsLoggedIn && !player.IsDisabledPendingTrashRemoval) { CharacterDB.InsertPlayerData(player); @@ -1083,7 +1083,7 @@ namespace TShockAPI if (Main.ServerSideCharacter && !player.IsLoggedIn) { - if (player.CheckIgnores()) + if (player.IsBeingDisabled()) { player.Disable(flags: flags); } @@ -1106,7 +1106,7 @@ namespace TShockAPI break; } } - player.IgnoreActionsForCheating = check; + player.IsDisabledForStackDetection = true; check = "none"; // Please don't remove this for the time being; without it, players wearing banned equipment will only get debuffed once foreach (Item item in player.TPlayer.armor) @@ -1161,9 +1161,9 @@ namespace TShockAPI break; } } - player.IgnoreActionsForDisabledArmor = check; + player.IsDisabledForBannedWearable = true; - if (player.CheckIgnores()) + if (player.IsBeingDisabled()) { player.Disable(flags: flags); } @@ -1409,7 +1409,7 @@ namespace TShockAPI Utils.Broadcast(tsplr.Name + " has left.", Color.Yellow); Log.Info("{0} disconnected.", tsplr.Name); - if (tsplr.IsLoggedIn && !tsplr.IgnoreActionsForClearingTrashCan && Main.ServerSideCharacter && (!tsplr.Dead || tsplr.TPlayer.difficulty != 2)) + if (tsplr.IsLoggedIn && !tsplr.IsDisabledPendingTrashRemoval && Main.ServerSideCharacter && (!tsplr.Dead || tsplr.TPlayer.difficulty != 2)) { tsplr.PlayerData.CopyCharacter(tsplr); CharacterDB.InsertPlayerData(tsplr); @@ -1684,8 +1684,8 @@ namespace TShockAPI { if (Main.ServerSideCharacter) { - player.SendErrorMessage( - player.IgnoreActionsForInventory = String.Format("Server side characters is enabled! Please {0}register or {0}login to play!", Commands.Specifier)); + player.IsDisabledForSSC = true; + player.SendErrorMessage(String.Format("Server side characters is enabled! Please {0}register or {0}login to play!", Commands.Specifier)); player.LoginHarassed = true; } else if (Config.RequireLogin)