chat_commands 1.1.1

Added help command to display the help message for a particular command.
An optional commandHelp argument has been added to the CreateCommand function.
A help command with no arguments can still be created. The script will understand the context and display the right info

Made examples in InitCommands() clearer by separating them and adding comments

Added comments to separate each command section: commands, help and other commands

small_scripts/chat_commands.gsc

@@ -30,13 +30,20 @@ InitChatCommands()
 
 InitCommands()
 {
-    CreateCommand(["27016"], "rules", "text", ["Do not camp", "Do not spawnkill", "Do not disrespect other players"]);
+    // All servers text commands
-    CreateCommand(["27017"], "rules", "text", ["Leave your spot and don't camp after using a M.O.A.B", "Don't leave while being infected", "Do not disrespect other players"]);
+    CreateCommand(level.commands_servers_ports, "help", "text", ["Type " + level.commands_prefix + "commands to get a list of commands", "Type " + level.commands_prefix + "help followed by a command name to see how to use it"]);
 
-    CreateCommand(level.commands_servers_ports, "suicide", "function", ::SuicideCommand);
+    // All servers function commands
-    CreateCommand(level.commands_servers_ports, "map", "function", ::ChangeMapCommand);
+    CreateCommand(level.commands_servers_ports, "map", "function", ::ChangeMapCommand, ["Example: " + level.commands_prefix + "map mp_dome"]);
-    CreateCommand(level.commands_servers_ports, "mode", "function", ::ChangeModeCommand);
+    CreateCommand(level.commands_servers_ports, "mode", "function", ::ChangeModeCommand, ["Example: " + level.commands_prefix + "mode FFA_default"]);
-    CreateCommand(level.commands_servers_ports, "mapmode", "function", ::ChangeMapAndModeCommand);
+    CreateCommand(level.commands_servers_ports, "mapmode", "function", ::ChangeMapAndModeCommand, ["Example: " + level.commands_prefix + "mapmode mp_seatown TDM_default"]);
+
+    // Specific server(s) text commands
+    CreateCommand(["27016", "27017"], "rules", "text", ["Do not camp", "Do not spawnkill", "Do not disrespect other players"]);
+    CreateCommand(["27018"], "rules", "text", ["Leave your spot and don't camp after using a M.O.A.B", "Don't leave while being infected", "Do not disrespect other players"]);
+
+    // Specific server(s) function commands
+    CreateCommand(["27016", "27017"], "suicide", "function", ::SuicideCommand);
 }
 
 /*
@@ -44,12 +51,17 @@ InitCommands()
 <commandName> the name of the command, this is what players will type in the chat
 <commandType> the type of the command: <text> is for arrays of text to display text in the player's chat and <function> is to execute a function
 */
-CreateCommand(serverPorts, commandName, commandType, commandValue)
+CreateCommand(serverPorts, commandName, commandType, commandValue, commandHelp)
 {
     foreach (serverPort in serverPorts)
     {
         level.commands[serverPort][commandName]["type"] = commandType;
 
+        if (IsDefined(commandHelp))
+        {
+            level.commands[serverPort][commandName]["help"] = commandHelp;
+        }
+    
         if (commandType == "text")
         {
             level.commands[serverPort][commandName]["text"] = commandValue;
@@ -90,13 +102,55 @@ ChatListener()
             args[args.size] = commandArray[i];
         }
 
+        // commands command
         if (command == level.commands_prefix + "commands")
         {
             player thread TellPlayer(GetArrayKeys(level.commands[GetDvar("net_port")]), 2, true);
         }
         else
         {
-            commandValue = level.commands[GetDvar("net_port")][GetSubStr(command, 1)];
+            // help command
+            if (command == level.commands_prefix + "help" && !IsDefined(level.commands[GetDvar("net_port")]["help"]) || command == level.commands_prefix + "help" && IsDefined(level.commands[GetDvar("net_port")]["help"]) && args.size >= 1)
+            {
+                if (args.size < 1)
+                {
+                    player thread TellPlayer(NotEnoughArgsError(1), 1.5);
+                }
+                else
+                {
+                    commandValue = level.commands[GetDvar("net_port")][args[0]];
+
+                    if (IsDefined(commandValue))
+                    {
+                        commandHelp = commandValue["help"];
+
+                        if (IsDefined(commandHelp))
+                        {
+                            player thread TellPlayer(commandHelp, 1.5);
+                        }
+                        else
+                        {
+                            player thread TellPlayer(CommandHelpDoesNotExistError(args[0]), 1);
+                        }
+                    }
+                    else
+                    {
+                        if (args[0] == "commands")
+                        {
+                            player thread TellPlayer(CommandHelpDoesNotExistError(args[0]), 1);
+                        }
+                        else
+                        {
+                            player thread TellPlayer(CommandDoesNotExistError(args[0]), 1);
+                        }
+                    }
+                }
+            }
+            // any other command
+            else
+            {
+                commandName = GetSubStr(command, 1);
+                commandValue = level.commands[GetDvar("net_port")][commandName];
 
                 if (IsDefined(commandValue))
                 {
@@ -116,7 +170,8 @@ ChatListener()
                 }
                 else
                 {
-                player thread TellPlayer(CommandDoesNotExistError(), 1);
+                    player thread TellPlayer(CommandDoesNotExistError(commandName), 1);
+                }
             }
         }
     }
@@ -205,9 +260,14 @@ ChangeMode(modeName, restart)
 
 /* Error functions section */
 
-CommandDoesNotExistError()
+CommandDoesNotExistError(commandName)
 {
-    return ["This command doesn't exist", "Type " + level.commands_prefix + "commands" + " to get a list of commands"];
+    return ["The command " + commandName + " doesn't exist", "Type " + level.commands_prefix + "commands to get a list of commands"];
+}
+
+CommandHelpDoesNotExistError(commandName)
+{
+    return ["The command " + commandName + " doesn't have any help message"];
 }
 
 NotEnoughArgsError(minimumArgs)