From d8f1324836dc49b86fceab2d05f4f2f9551b507d Mon Sep 17 00:00:00 2001 From: Lucas Nicodemus Date: Sat, 28 Feb 2015 19:47:27 -0700 Subject: [PATCH] Utils.cs now has uniform tabs --- TShockAPI/Utils.cs | 238 ++++++++++++++++++++++----------------------- 1 file changed, 119 insertions(+), 119 deletions(-) diff --git a/TShockAPI/Utils.cs b/TShockAPI/Utils.cs index 8811db0c..31eab7fa 100644 --- a/TShockAPI/Utils.cs +++ b/TShockAPI/Utils.cs @@ -35,17 +35,17 @@ namespace TShockAPI /// public class Utils { - /// - /// The lowest id for a prefix. - /// - private const int FirstItemPrefix = 1; + /// + /// The lowest id for a prefix. + /// + private const int FirstItemPrefix = 1; - /// - /// The highest id for a prefix. - /// - private const int LastItemPrefix = 83; + /// + /// The highest id for a prefix. + /// + private const int LastItemPrefix = 83; - // Utils is a Singleton + // Utils is a Singleton private static readonly Utils instance = new Utils(); private Utils() {} public static Utils Instance { get { return instance; } } @@ -67,7 +67,7 @@ namespace TShockAPI /// Used for some places where a list of players might be used. /// /// String of players seperated by commas. - [Obsolete("Use GetPlayers and manually create strings. This should never have been kept as far as actual functions go.")] + [Obsolete("Use GetPlayers and manually create strings. This should never have been kept as far as actual functions go.")] public string GetPlayers() { var sb = new StringBuilder(); @@ -85,56 +85,56 @@ namespace TShockAPI return sb.ToString(); } - /// - /// Returns a list of current players on the server - /// - /// bool includeIDs - whether or not the string of each player name should include ID data - /// List of strings with names - public List GetPlayers(bool includeIDs) - { - var players = new List(); + /// + /// Returns a list of current players on the server + /// + /// bool includeIDs - whether or not the string of each player name should include ID data + /// List of strings with names + public List GetPlayers(bool includeIDs) + { + var players = new List(); - foreach (TSPlayer ply in TShock.Players) - { - if (ply != null && ply.Active) - { - if (includeIDs) - { - players.Add(ply.Name + " (IX: " + ply.Index + ", ID: " + ply.UserID + ")"); - } - else - { - players.Add(ply.Name); - } - } - } + foreach (TSPlayer ply in TShock.Players) + { + if (ply != null && ply.Active) + { + if (includeIDs) + { + players.Add(ply.Name + " (IX: " + ply.Index + ", ID: " + ply.UserID + ")"); + } + else + { + players.Add(ply.Name); + } + } + } - return players; - } + return players; + } - /// - /// Used for some places where a list of players might be used. - /// - /// String of players and their id seperated by commas. - [Obsolete("Use GetPlayers and manually create strings. This should never have been kept as far as actual functions go.")] - public string GetPlayersWithIds() - { - var sb = new StringBuilder(); - foreach (TSPlayer player in TShock.Players) - { - if (player != null && player.Active) - { - if (sb.Length != 0) - { - sb.Append(", "); - } - sb.Append(player.Name); - string id = "(ID: " + Convert.ToString(TShock.Users.GetUserID(player.UserAccountName)) + ", IX:" + player.Index + ")"; - sb.Append(id); - } - } - return sb.ToString(); - } + /// + /// Used for some places where a list of players might be used. + /// + /// String of players and their id seperated by commas. + [Obsolete("Use GetPlayers and manually create strings. This should never have been kept as far as actual functions go.")] + public string GetPlayersWithIds() + { + var sb = new StringBuilder(); + foreach (TSPlayer player in TShock.Players) + { + if (player != null && player.Active) + { + if (sb.Length != 0) + { + sb.Append(", "); + } + sb.Append(player.Name); + string id = "(ID: " + Convert.ToString(TShock.Users.GetUserID(player.UserAccountName)) + ", IX:" + player.Index + ")"; + sb.Append(id); + } + } + return sb.ToString(); + } /// /// Finds a player and gets IP as string @@ -204,20 +204,20 @@ namespace TShockAPI Broadcast(msg, color.R, color.G, color.B); } - /// - /// Broadcasts a message from a player, not TShock - /// - /// TSPlayer ply - the player that will send the packet - /// string msg - the message - /// r - /// g - /// b - public void Broadcast(int ply, string msg, byte red, byte green, byte blue) - { - TSPlayer.All.SendMessageFromPlayer(msg, red, green, blue, ply); - TSPlayer.Server.SendMessage(Main.player[ply].name + ": " + msg, red, green, blue); - TShock.Log.Info(string.Format("Broadcast: {0}", Main.player[ply].name + ": " + msg)); - } + /// + /// Broadcasts a message from a player, not TShock + /// + /// TSPlayer ply - the player that will send the packet + /// string msg - the message + /// r + /// g + /// b + public void Broadcast(int ply, string msg, byte red, byte green, byte blue) + { + TSPlayer.All.SendMessageFromPlayer(msg, red, green, blue, ply); + TSPlayer.Server.SendMessage(Main.player[ply].name + ": " + msg, red, green, blue); + TShock.Log.Info(string.Format("Broadcast: {0}", Main.player[ply].name + ": " + msg)); + } /// /// Sends message to all players with 'logs' permission. @@ -232,7 +232,7 @@ namespace TShockAPI foreach (TSPlayer player in TShock.Players) { if (player != null && player != excludedPlayer && player.Active && player.Group.HasPermission(Permissions.logs) && - player.DisplayLogs && TShock.Config.DisableSpewLogs == false) + player.DisplayLogs && TShock.Config.DisableSpewLogs == false) player.SendMessage(log, color); } } @@ -293,7 +293,7 @@ namespace TShockAPI /// X location /// Y location public void GetRandomClearTileWithInRange(int startTileX, int startTileY, int tileXRange, int tileYRange, - out int tileX, out int tileY) + out int tileX, out int tileY) { int j = 0; do @@ -509,8 +509,8 @@ namespace TShockAPI } return found; } - - /// + + /// /// Gets a prefix by ID or name /// /// ID or name @@ -635,18 +635,18 @@ namespace TShockAPI { string playerName = player.Name; player.SilentKickInProgress = silent; - if (player.IsLoggedIn && saveSSI) - player.SaveServerCharacter(); + if (player.IsLoggedIn && saveSSI) + player.SaveServerCharacter(); player.Disconnect(string.Format("Kicked: {0}", reason)); TShock.Log.ConsoleInfo(string.Format("Kicked {0} for : '{1}'", playerName, reason)); string verb = force ? "force " : ""; - if (!silent) - { - if (string.IsNullOrWhiteSpace(adminUserName)) - Broadcast(string.Format("{0} was {1}kicked for '{2}'", playerName, verb, reason.ToLower()), Color.Green); - else + if (!silent) + { + if (string.IsNullOrWhiteSpace(adminUserName)) + Broadcast(string.Format("{0} was {1}kicked for '{2}'", playerName, verb, reason.ToLower()), Color.Green); + else Broadcast(string.Format("{0} {1}kicked {2} for '{3}'", adminUserName, verb, playerName, reason.ToLower()), Color.Green); - } + } return true; } return false; @@ -687,28 +687,28 @@ namespace TShockAPI return false; } - public bool HasBanExpired(Ban ban, bool byName = false) - { - DateTime exp; - bool expirationExists = DateTime.TryParse(ban.Expiration, out exp); + public bool HasBanExpired(Ban ban, bool byName = false) + { + DateTime exp; + bool expirationExists = DateTime.TryParse(ban.Expiration, out exp); - if (!string.IsNullOrWhiteSpace(ban.Expiration) && (expirationExists) && - (DateTime.UtcNow >= exp)) - { - if (byName) - { - TShock.Bans.RemoveBan(ban.Name, true, true, false); - } - else - { - TShock.Bans.RemoveBan(ban.IP, false, false, false); - } - - return true; - } + if (!string.IsNullOrWhiteSpace(ban.Expiration) && (expirationExists) && + (DateTime.UtcNow >= exp)) + { + if (byName) + { + TShock.Bans.RemoveBan(ban.Name, true, true, false); + } + else + { + TShock.Bans.RemoveBan(ban.IP, false, false, false); + } + + return true; + } - return false; - } + return false; + } /// /// Shows a file to the user. @@ -762,7 +762,7 @@ namespace TShockAPI return TShock.Groups.groups[i]; } } - return Group.DefaultGroup; + return Group.DefaultGroup; } /// @@ -796,23 +796,23 @@ namespace TShockAPI ply.SendErrorMessage("Use \"my query\" for items with spaces"); } - /// - /// Default hashing algorithm. - /// - public string HashAlgo = "sha512"; + /// + /// Default hashing algorithm. + /// + public string HashAlgo = "sha512"; - /// - /// A dictionary of hashing algortihms and an implementation object. - /// + /// + /// A dictionary of hashing algortihms and an implementation object. + /// public readonly Dictionary> HashTypes = new Dictionary> - { - {"sha512", () => new SHA512Managed()}, - {"sha256", () => new SHA256Managed()}, - {"md5", () => new MD5Cng()}, - {"sha512-xp", () => SHA512.Create()}, - {"sha256-xp", () => SHA256.Create()}, - {"md5-xp", () => MD5.Create()}, - }; + { + {"sha512", () => new SHA512Managed()}, + {"sha256", () => new SHA256Managed()}, + {"md5", () => new MD5Cng()}, + {"sha512-xp", () => SHA512.Create()}, + {"sha256-xp", () => SHA256.Create()}, + {"md5-xp", () => MD5.Create()}, + }; /// /// Returns a Sha256 string for a given string