small impovements

Author: HerrMagiic

CustomCommands/Interfaces/ILoadJson.cs

@@ -4,11 +4,52 @@ namespace CustomCommands.Interfaces;
 
 public interface ILoadJson
 {
-    List<Commands> GetCommandsFromJsonFiles(string path);
+    /// <summary>
+    /// Retrieves a list of commands from JSON files located in the specified path.
+    /// </summary>
+    /// <param name="path">The path where the JSON files are located.</param>
+    /// <returns>A list of commands.</returns>
+    Task<List<Commands>> GetCommandsFromJsonFiles(string path);
+
+    /// <summary>
+    /// Checks if an .example file exists in the specified path and creates a default config file if it doesn't exist.
+    /// </summary>
+    /// <param name="path">The path to check for the example file.</param>
     void CheckForExampleFile(string path);
-    bool IsValidJsonSyntax(string jsonString);
+
+    /// <summary>
+    /// Checks if the JSON file has a valid syntax.
+    /// </summary>
+    /// <param name="path">The path to the JSON file.</param>
+    /// <param name="json">The json string.</param>
+    /// <returns>True if the JSON syntax is valid, false otherwise.</returns>
+    bool IsValidJsonSyntax(string json, string path);
+
+    /// <summary>
+    /// Validates the list of commands loaded from a JSON file.
+    /// </summary>
+    /// <param name="comms">The list of commands to validate.</param>
+    /// <param name="path">The path of the JSON file.</param>
+    /// <returns>True if all commands are valid, false otherwise.</returns>
     bool ValidateObject(List<Commands>? comms, string path);
+
+    /// <summary>
+    /// Logs the details of a command.
+    /// </summary>
+    /// <param name="comms">The command to log.</param>
     void LogCommandDetails(Commands comms);
+
+    /// <summary>
+    /// Validates the PrintTo property of the Commands object and checks if the required message properties are set based on the PrintTo value.
+    /// </summary>
+    /// <param name="comms">The Commands object to validate.</param>
+    /// <returns>True if the PrintTo property is valid and the required message properties are set; otherwise, false.</returns>
     bool PrintToCheck(Commands comms);
+
+    /// <summary>
+    /// Validates a dynamic message by checking if it is a string or an array.
+    /// </summary>
+    /// <param name="message">The dynamic message to validate.</param>
+    /// <returns>True if the message is a string or an array, otherwise false.</returns>
     bool ValidateMessage(dynamic message);
 }

CustomCommands/Interfaces/IMessageManager.cs

@@ -5,6 +5,11 @@ namespace CustomCommands.Interfaces;
 
 public interface IMessageManager
 {
+    /// <summary>
+    /// Sends a message based on the specified command and target receiver.
+    /// </summary>
+    /// <param name="player">The player who triggered the command.</param>
+    /// <param name="cmd">The command containing the message and target receiver.</param>
     void SendMessage(CCSPlayerController player, Commands cmd);
     void PrintToCenterClient(CCSPlayerController player, Commands cmd);
     void PrintToAllCenter(Commands cmd);

CustomCommands/Interfaces/IReplaceTagsFunctions.cs

@@ -4,9 +4,40 @@ namespace CustomCommands.Interfaces;
 
 public interface IReplaceTagsFunctions
 {
+    /// <summary>
+    /// Replaces tags in the input array with their corresponding values.
+    /// </summary>
+    /// <param name="input">The array of strings containing tags to be replaced.</param>
+    /// <param name="player">The CCSPlayerController object used for tag replacement.</param>
+    /// <returns>The array of strings with tags replaced.</returns>
     string[] ReplaceTags(dynamic input, CCSPlayerController player);
+
+    /// <summary>
+    /// Replaces language tags in the input string with the corresponding localized value.
+    /// Language tags are defined within curly braces, e.g. "{LANG=LocalizerTag}".
+    /// If a language tag is found, it is replaced with the localized value from the CustomCommands plugin's Localizer.
+    /// If the localized value is not found, a default message is returned.
+    /// </summary>
+    /// <param name="input">The input string to process.</param>
+    /// <returns>The input string with language tags replaced with localized values.</returns>
     string ReplaceLanguageTags(string input);
+
+    /// <summary>
+    /// Replaces tags in the input string with corresponding values based on the provided player information.
+    /// </summary>
+    /// <param name="input">The input string containing tags to be replaced.</param>
+    /// <param name="player">The CCSPlayerController object representing the player.</param>
+    /// <param name="safety">A boolean value indicating whether to replace the {PLAYERNAME} tag. Default is true.</param>
+    /// <returns>The modified string with replaced tags.</returns>
     string ReplaceMessageTags(string input, CCSPlayerController player, bool safety = true);
     string ReplaceColorTags(string input);
+
+    /// <summary>
+    /// Splits the input into an array of strings. If the input is a string, it will be split by newlines. If the input is an array, each element will be split by newlines.
+    /// </summary>
+    /// <param name="input">This should be a string[] or a string</param>
+    /// <returns>An array of strings representing the lines of the input.</returns>
     List<string> WrappedLine(dynamic message);
+
+    string ReplaceRandomTags(string message);
 }

CustomCommands/Services/CooldownManager.cs

@@ -6,12 +6,13 @@ namespace CustomCommands.Interfaces;
 
 public class CooldownManager : ICooldownManager
 {
-    public IPluginGlobals PluginGlobals { get; }
-    public IReplaceTagsFunctions ReplaceTagsFunctions { get; }
+    public IPluginGlobals _pluginGlobals { get; }
+    public IReplaceTagsFunctions _replaceTagsFunctions { get; }
+    
     public CooldownManager(IPluginGlobals PluginGlobals, IReplaceTagsFunctions ReplaceTagsFunctions)
     {
-        this.PluginGlobals          = PluginGlobals;
-        this.ReplaceTagsFunctions   = ReplaceTagsFunctions;
+        _pluginGlobals          = PluginGlobals;
+        _replaceTagsFunctions   = ReplaceTagsFunctions;
     }
 
     /// <summary>
@@ -42,11 +43,11 @@ public bool IsCommandOnCooldown(CCSPlayerController player, Commands cmd)
     /// <returns>True if the command is on cooldown, false otherwise.</returns>
     public bool IsCommandOnCooldownWithCondition(Func<CooldownTimer, bool> predicate, CCSPlayerController player, Commands cmd)
     {
-        var index = PluginGlobals.CooldownTimer.FindIndex(x => predicate(x) && x.CooldownTime > DateTime.Now);
+        var index = _pluginGlobals.CooldownTimer.FindIndex(x => predicate(x) && x.CooldownTime > DateTime.Now);
 
         if (index != -1)
         {
-            var totalSeconds         = (double)PluginGlobals.CooldownTimer[index].CooldownTime.Subtract(DateTime.Now).TotalSeconds;
+            var totalSeconds         = (double)_pluginGlobals.CooldownTimer[index].CooldownTime.Subtract(DateTime.Now).TotalSeconds;
             var totalSecondsRounded     = (int)Math.Round(totalSeconds);
             var timeleft             = totalSecondsRounded.ToString();
             var message              = "";
@@ -57,14 +58,14 @@ public bool IsCommandOnCooldownWithCondition(Func<CooldownTimer, bool> predicate
                 var cooldown = JsonSerializer.Deserialize<Cooldown>(cmd.Cooldown.GetRawText());
                 Console.WriteLine(cooldown.CooldownMessage);
                 string[] replaceTimeleft = {cooldown.CooldownMessage.Replace("{TIMELEFT}", timeleft)};
-                message = ReplaceTagsFunctions.ReplaceTags(replaceTimeleft, player)[0];
+                message = _replaceTagsFunctions.ReplaceTags(replaceTimeleft, player)[0];
             }
             catch (JsonException)
             {
                 message = $"This command is for {timeleft} seconds on cooldown";
             }
 
-            player.PrintToChat($"{PluginGlobals.Config.Prefix}{message}");
+            player.PrintToChat($"{_pluginGlobals.Config.Prefix}{message}");
 
             return true;
         }
@@ -89,25 +90,25 @@ public void AddToCooldownList(bool isGlobal, int playerID, Guid commandID, int c
 
         if (isGlobal)
         {
-            int index = PluginGlobals.CooldownTimer.FindIndex(x => 
+            int index = _pluginGlobals.CooldownTimer.FindIndex(x => 
                 x.IsGlobal == true 
                 && x.CommandID == commandID);
 
             if (index != -1)
-                PluginGlobals.CooldownTimer[index].CooldownTime = timer.CooldownTime;
+                _pluginGlobals.CooldownTimer[index].CooldownTime = timer.CooldownTime;
             else
-                PluginGlobals.CooldownTimer.Add(timer);
+                _pluginGlobals.CooldownTimer.Add(timer);
         }
         else
         {
             timer.PlayerID = playerID;
-            int index = PluginGlobals.CooldownTimer.FindIndex(x => 
+            int index = _pluginGlobals.CooldownTimer.FindIndex(x => 
                 x.PlayerID == playerID 
                 && x.CommandID == commandID);
             if (index != -1)
-                PluginGlobals.CooldownTimer[index].CooldownTime = timer.CooldownTime;
+                _pluginGlobals.CooldownTimer[index].CooldownTime = timer.CooldownTime;
             else
-                PluginGlobals.CooldownTimer.Add(timer);
+                _pluginGlobals.CooldownTimer.Add(timer);
         }
     }
 
@@ -124,7 +125,7 @@ public void SetCooldown(CCSPlayerController player, Commands cmd)
             {
                 case JsonValueKind.Number:
 
-                    int cooldown = cmd.Cooldown.GetInt32();
+                    var cooldown = cmd.Cooldown.GetInt32();
                     if (cooldown == 0) 
                         break;
 

CustomCommands/Services/EventManager.cs

@@ -8,37 +8,37 @@ namespace CustomCommands.Services;
 
 public class EventManager : IEventManager
 {
-    private readonly IPluginGlobals PluginGlobals;
-    private readonly PluginContext PluginContext;
-    private readonly IReplaceTagsFunctions ReplaceTagsFunctions;
+    private readonly IPluginGlobals _pluginGlobals;
+    private readonly PluginContext _pluginContext;
+    private readonly IReplaceTagsFunctions _replaceTagsFunctions;
 
     public EventManager(IPluginGlobals PluginGlobals, IPluginContext PluginContext, IReplaceTagsFunctions ReplaceTagsFunctions)
     {
-        this.PluginGlobals          = PluginGlobals;
-        this.PluginContext          = (PluginContext as PluginContext)!;
-        this.ReplaceTagsFunctions   = ReplaceTagsFunctions;
+        _pluginGlobals          = PluginGlobals;
+        _pluginContext          = (PluginContext as PluginContext)!;
+        _replaceTagsFunctions   = ReplaceTagsFunctions;
     }
 
     [GameEventHandler]
     public HookResult OnPlayerDisconnect(EventPlayerDisconnect @event, GameEventInfo _)
     {
-        PluginGlobals.centerClientOn.RemoveAll(p => p.ClientId == @event.Userid.UserId);
-        PluginGlobals.CooldownTimer.RemoveAll(p => p.PlayerID == @event.Userid.UserId);
+        _pluginGlobals.centerClientOn.RemoveAll(p => p.ClientId == @event.Userid.UserId);
+        _pluginGlobals.CooldownTimer.RemoveAll(p => p.PlayerID == @event.Userid.UserId);
 
         return HookResult.Continue;
     }
 
     public void RegisterListeners()
     {
-        CustomCommands plugin = (PluginContext.Plugin as CustomCommands)!;
+        var plugin = (_pluginContext.Plugin as CustomCommands)!;
 
         // Register the OnTick event for PrintToCenterHtml duration
         plugin.RegisterListener<Listeners.OnTick>(() =>
         {
             // Client Print To Center
-            if(PluginGlobals.centerClientOn != null && PluginGlobals.centerClientOn.Count !> 0 )
+            if(_pluginGlobals.centerClientOn != null && _pluginGlobals.centerClientOn.Count !> 0 )
             {
-                foreach (var player in PluginGlobals.centerClientOn)
+                foreach (var player in _pluginGlobals.centerClientOn)
                 {
                     var targetPlayer = Utilities.GetPlayerFromUserid(player.ClientId);
                     if (player != null && targetPlayer != null)
@@ -49,23 +49,23 @@ public void RegisterListeners()
             }
 
             // Server Print To Center
-            if (PluginGlobals.centerServerOn.IsRunning)
+            if (_pluginGlobals.centerServerOn.IsRunning)
             {
                 Utilities.GetPlayers().ForEach(controller =>
                 {
                     if (!controller.IsValid || controller.SteamID == 0) return;
 
-                    string message = ReplaceTagsFunctions.ReplaceLanguageTags(PluginGlobals.centerServerOn.Message);
-                    message = ReplaceTagsFunctions.ReplaceMessageTags(message, controller);
+                    var message = _replaceTagsFunctions.ReplaceLanguageTags(_pluginGlobals.centerServerOn.Message);
+                    message = _replaceTagsFunctions.ReplaceMessageTags(message, controller);
                     controller.PrintToCenterHtml(message, 1);
                 });
             }
         });
 
         plugin.RegisterListener<Listeners.OnMapEnd>(() =>
         {
-            PluginGlobals.centerClientOn.Clear();
-            PluginGlobals.CooldownTimer.Clear();
+            _pluginGlobals.centerClientOn.Clear();
+            _pluginGlobals.CooldownTimer.Clear();
         });
     }
 }