Merge pull request #46 from XanatosX/feature/43_add-custom-command-require-data-type

feat: add data types to command arguments

Author: XanatosX

README.md

@@ -34,6 +34,30 @@ func _reload() -> String:
 	get_tree().reload_current_scene()
 	return "reloaded scene"
 ```
+> This will add an command where the arguments are provided as Strings, your method accepting those arguments will get strings as well
+> you will need to convert to the correct data type all by yourself.
+
+### Register a strong argument command
+
+```gdscript
+Console.register_custom_strong_command("spawn_entity",
+                                       _spawn_entity,
+                                       [CommandArgument.new(CommandArgument.Type.INT, "X Position", "The x position on screen for the entity"),
+                                        CommandArgument.new(CommandArgument.Type.INT, "y Position", "The y position on screen for the entity"),
+                                        CommandArgument.new(CommandArgument.Type.FLOAT, "time to life", "The time the entity should life in seconds")
+                                       ],
+                                       "Spawn an example entity at a global position",
+                                       "",
+                                       ["spawn_entity 200 300 4"]
+                                      )
+
+func _spawn_entity(pos_x: int, pos_y: int, ttl: float) -> String:
+    pass
+
+```
+> This will add a new argument but the argument types are defined, this will parse the input data automatically making it easier to use in your method. If a wrong type was provided to any
+> of the arguments an error will be thrown preventing the method execution.
+
 
 ### Unregister a command
 

addons/gameconsole/builtin/command_argument_count_not_matching.gd

@@ -1,7 +1,11 @@
 extends CommandTemplate
 
 func create_command() -> Command:
-    var command = Command.new("argument not matching", _argument_count_not_matching, ["command_name"], "The provided arguments do not match")
+    var command = Command.new("argument not matching",
+							  _argument_count_not_matching,
+							  [CommandArgument.new(CommandArgument.Type.STRING, "Command Name", "")],
+							  "The provided arguments do not match"
+							  )
     command.is_hidden = true
     return command
 

addons/gameconsole/builtin/command_argument_not_valid.gd

@@ -0,0 +1,18 @@
+extends CommandTemplate
+
+func create_command() -> Command:
+	var command = Command.new("argument_not_valid",
+							  _argument_is_not_valid,
+							  [CommandArgument.new(CommandArgument.Type.STRING, "Command Name", ""),
+							   CommandArgument.new(CommandArgument.Type.STRING, "Argument Name", ""),
+							   CommandArgument.new(CommandArgument.Type.STRING, "Expected Type", ""),
+							   CommandArgument.new(CommandArgument.Type.STRING, "Provided Data", "")
+							  ],
+							  "The type of the given argument is not correct"
+							  )
+	command.is_hidden = true
+	return command
+
+func _argument_is_not_valid(command_name: String, argument_name: String, expected_type: String, provided_data: String) -> String:
+	argument_name = argument_name.replace("_", " ")
+	return "[color=red]Command \"%s\" does require (%s) type for argument \"%s\" but provided value was \"%s\"[/color]" % [command_name, expected_type, argument_name, provided_data]

addons/gameconsole/builtin/command_man.gd

@@ -1,10 +1,15 @@
 extends CommandTemplate
 
 func create_command() -> Command:
-    var command = Command.new("man", manual, ["Name of the command"], "Command to get a manual for an command", "", ["man list_commands"])
+    var command = Command.new("man",
+							  _manual,
+							  [CommandArgument.new(CommandArgument.Type.STRING, "Name of the command", "")],
+							  "Command to get a manual for an command",
+							  "",
+							  ["man list_commands"])
     return command
 
-func manual(command_name: String) -> String:
+func _manual(command_name: String) -> String:
     var command = Console.get_specific_command(command_name)
     if command == null or command.is_hidden:
         return "[color=red]No command with name %s was found[/color]" % command_name

addons/gameconsole/builtin/command_not_found.gd

@@ -1,7 +1,11 @@
 extends CommandTemplate
 
 func create_command() -> Command:
-    var command = Command.new("not found", _not_found, ["Command name"], "Command was not found")
+    var command = Command.new("not found",
+							  _not_found,
+							  [CommandArgument.new(CommandArgument.Type.STRING, "Command Name", "")],
+							  "Command was not found"
+							 )
     command.is_hidden = true
     return command
 

addons/gameconsole/console/command/command.gd

@@ -2,7 +2,7 @@ class_name Command extends Node
 
 var command: String
 var function: Callable
-var arguments : PackedStringArray
+var arguments : Array[CommandArgument]
 
 var short_description: String
 var description: String
@@ -16,7 +16,7 @@ var self_example_links := {}
 
 func _init(command_name: String,
 		   functionality: Callable,
-		   in_arguments : PackedStringArray = [],
+		   in_arguments : Array[CommandArgument] = [],
 		   command_description: String = "",
 		   long_description: String = "",
 		   command_examples: PackedStringArray = []
@@ -41,8 +41,32 @@ func _init(command_name: String,
 func get_command_name() -> String :
 	return command
 
-func execute(arguments: Array) -> String:
-	var data = function.callv(arguments)
+func execute(in_arguments: Array) -> String:
+	if in_arguments.size() != arguments.size():
+		Console.search_and_execute_command("argument_not_matching %s" % command)
+		return ""
+
+	var is_valid: bool = true
+	for i in in_arguments.size():
+		var current_argument_type = arguments[i]
+		if not current_argument_type.is_valid_for(in_arguments[i]):
+			is_valid = false
+			var data = "%s %s %s %s %s" % ["argument_not_valid",
+										   command,
+										   current_argument_type.get_display_name().to_snake_case(),
+										   current_argument_type.Type.keys()[current_argument_type.get_type()],
+										   in_arguments[i]
+										  ]
+			Console.search_and_execute_command(data)
+			return ""
+
+
+	var converted_data: Array[Variant] = []
+	for i in in_arguments.size():
+		var data = arguments[i].convert_data(in_arguments[i])
+		converted_data.append(data)
+
+	var data = function.callv(converted_data)
 	if data == null:
 		data = ""
 	return data
@@ -57,7 +81,7 @@ func get_command_short_description():
 func get_arguments() -> String:
 	var return_arguments = ""
 	for argument in arguments:
-		return_arguments += "[%s]" % argument
+		return_arguments += "[%s]" % argument.get_display_name()
 	return return_arguments
 
 func as_stripped() -> StrippedCommand:
@@ -77,7 +101,12 @@ func get_man_page() -> String:
 		return_text += "\n[i][b]Arguments[/b][/i]\n\n"
 		return_text += "[ul]"
 		for argument in arguments:
-			return_text += "%s\n" % argument
+			return_text += "%s" % argument.get_display_name()
+			var argument_description = argument.get_description()
+			if not argument_description.is_empty():
+				return_text += " -> %s" % argument_description
+			return_text += "\n"
+
 		return_text += "[/ul]"
 	if examples.size() > 0:
 		return_text += "\n\n[i][b]Examples[/b][/i]\n\n"

addons/gameconsole/console/command/command_argument.gd

@@ -0,0 +1,75 @@
+class_name CommandArgument extends Resource
+
+enum Type
+{
+	UNKNOWN,
+	STRING,
+	INT,
+	FLOAT,
+	BOOL,
+}
+
+var _argument_type: Type
+var _argument_name: String
+var _argument_description: String = ""
+
+func _init(type: Type, name: String, description: String):
+	_argument_type = type
+	_argument_name = name
+	_argument_description = description
+	
+func get_type() -> Type:
+	return _argument_type
+
+func get_display_name() -> String:
+	var prefix: String = "(%s)"
+	match _argument_type:
+		Type.UNKNOWN:
+			prefix = ""
+		Type.STRING:
+			prefix = prefix % "String"
+		Type.INT:
+			prefix = prefix % "Int"
+		Type.FLOAT:
+			prefix = prefix % "Float"
+		Type.BOOL:
+			prefix = prefix % "Bool 0/1"
+	return "%s %s" % [prefix, _argument_name]
+
+func get_description() -> String:
+	return _argument_description
+
+func is_valid_for(data: String) -> bool:
+	match _argument_type:
+		Type.UNKNOWN:
+			return true
+		Type.STRING:
+			return true
+		Type.INT:
+			return data.is_valid_int()
+		Type.FLOAT:
+			return data.is_valid_float()
+		Type.BOOL:
+			if not data.is_valid_int():
+				return false
+			var converted_data = int(data)
+			return converted_data == 0 or converted_data == 1
+		_:
+			return false
+
+func convert_data(data: String) -> Variant:
+	if not is_valid_for(data):
+		return null
+	match _argument_type:
+		Type.UNKNOWN:
+			return data
+		Type.STRING:
+			return data
+		Type.INT:
+			return int(data)
+		Type.FLOAT:
+			return float(data)
+		Type.BOOL:
+			return int(data) == 1
+		_:
+			return null

addons/gameconsole/console/command/stripped_command.gd

@@ -1,4 +1,4 @@
 class_name StrippedCommand extends Resource
 
 var command: String
-var arguments: PackedStringArray
+var arguments: Array[CommandArgument]

addons/gameconsole/console/console.gd

@@ -150,15 +150,29 @@ func _register_builtin_command(command: Command):
 	command.built_in = true
 	_console_commands[command.get_command_name()] = command
 
-func register_custom_command(command: String,
-									  function: Callable,
-									  in_arguments : PackedStringArray = [],
-									  short_description: String = "",
-									  description: String = "",
-									  example: PackedStringArray = []):
+## Register a custom command with strong typed parameters
+func register_custom_strong_command(command: String,
+							 function: Callable,
+							 in_arguments: Array[CommandArgument],
+							 short_description: String = "",
+							 description: String = "",
+							 example: PackedStringArray = []):
 	var real_command = Command.new(command, function, in_arguments, short_description, description, example)
 	register_command(real_command)
 
+## Register a custom command without using the new parameter types
+func register_custom_command(command: String,
+							 function: Callable,
+							 in_arguments : PackedStringArray = [],
+							 short_description: String = "",
+							 description: String = "",
+							 example: PackedStringArray = []):
+	var converted_arguments: Array[CommandArgument] = []
+	for argument in in_arguments:
+		converted_arguments.append(CommandArgument.new(CommandArgument.Type.UNKNOWN, argument, ""))
+	register_custom_strong_command(command, function, converted_arguments, short_description, description, example)
+
+## Register a new command you already created the object instance for
 func register_command(command: Command):
 	var name = command.get_command_name()
 	command.built_in = false
@@ -180,8 +194,6 @@ func search_and_execute_command(command_text: String):
 	if command_to_run == null:
 		search_and_execute_command("not_found %s" % executer.command)
 		return
-	if executer.arguments.size() != command_to_run.arguments.size():
-		search_and_execute_command("argument_not_matching %s" % executer.command)
 	var result = command_to_run.execute(executer.arguments)
 	if result != "":
 		console_output.emit(result + "\n")

addons/gameconsole/console/console/autocomplete_label.gd

@@ -43,7 +43,7 @@ func _display_autocomplete(data: StrippedCommand):
 		var color: Color = Console.console_settings.autocomplete_argument_color_odd
 		if argument_counter % 2 == 0:
 			color = Console.console_settings.autocomplete_argument_color_even
-		arguments += "[color=%s]%s[/color] " % [color.to_html(), argument]
+		arguments += "[color=%s]%s[/color] " % [color.to_html(), argument.get_display_name()]
 		argument_counter += 1
 	arguments = arguments.trim_suffix(" ")