Added Help Command

Author: maxfleetdev

README.md.meta

@@ -9,6 +9,7 @@ public struct CommandData
         #region Properties
 
         public string CommandName { get; }
+        public string CommandDesc { get; }
         public MethodInfo MethodData { get; }
         public object TargetClass { get; }
         public CommandFlags Flags { get; }  // Set roles and flags?
@@ -17,10 +18,11 @@ public struct CommandData
 
         #region Constructors
 
-        public CommandData(string commandName, MethodInfo methodData,
+        public CommandData(string commandName, string commandDesc, MethodInfo methodData,
             object targetClass, CommandFlags flags = CommandFlags.None)
         {
             CommandName = commandName;
+            CommandDesc = commandDesc;
             MethodData = methodData;
             TargetClass = targetClass;
             Flags = flags;

Runtime/Core/CommandData.cs

@@ -2,8 +2,9 @@
 using System.Collections.Generic;
 using System.Reflection;
 using UnityEngine;
+using Commander.Core;
 
-namespace Commander.Core
+namespace Commander
 {
     public static class CommandRegistry
     {
@@ -83,7 +84,14 @@ public static void RegisterInstanceCommands(object targetClass = null)
                 }
 
                 // Assign value of dictionary as new CommandData
-                _registeredCommands[cmdName] = new CommandData(cmdName, methodInfo, targetClass);
+                _registeredCommands[cmdName] = new CommandData(
+                    cmdName,
+                    cmdAttribute.Descrption,
+                    methodInfo,
+                    targetClass
+                    // add flags here
+                );
+
                 Debug.Log($"[CommandRegistry] Registered Command '{cmdName}'");
             }
         }
@@ -106,7 +114,7 @@ public static void RegisterStaticCommands()
                             continue;
                         }
                         string cmdName = string.IsNullOrWhiteSpace(attr.Name) ? method.Name : attr.Name;
-                        _registeredCommands[cmdName] = new CommandData(cmdName, method, null);
+                        _registeredCommands[cmdName] = new CommandData(cmdName, attr.Descrption, method, null);
                         Debug.Log($"[CommandRegistry] Registered Static Command '{cmdName}'");
                     }
                 }
@@ -148,5 +156,18 @@ public static ParameterInfo[] GetParameters(string commandName)
         }
 
         #endregion
+
+        [Command("help", "Shows all commands and their functions")]
+        public static void ShowAllCommands()
+        {
+            foreach (KeyValuePair<string, CommandData> kvp in _registeredCommands)
+            {
+                if (kvp.Value.Flags == CommandFlags.Hidden)
+                {
+                    continue;
+                }
+                Debug.Log(kvp.Key + " - " + kvp.Value.CommandDesc);
+            }
+        }
     }
 }

Runtime/Core/CommandRegistry.cs

@@ -1,18 +1,23 @@
 using UnityEngine;
 using Commander;
-using Commander.Core;
 
 public class TestCommand : MonoBehaviour
 {
     void Awake()
     {
         CommandRegistry.RegisterInstanceCommands(this);
-        CommandExecutor.ExecuteCommand("test enum 'hello world'");
+        CommandExecutor.ExecuteCommand("help");
     }
 
-    [Command("test", CommandRole.Any)]
+    [Command("test", "This is a test", CommandRole.Any)]
     public void PublicMyCommand(int a, string b)
     {
         Debug.Log($"Command executed with parameters: a = {a}, b = {b}");
     }
+
+    [Command("AnotherTest", "This is yet another test", CommandRole.Any)]
+    public void AnotherCommand(int a)
+    {
+        Debug.Log($"Command executed with parameters: a = {a}");
+    }
 }