Merge pull request #18 from XanatosX/develop

Release 0.3.0

Author: XanatosX

README.md

@@ -13,7 +13,12 @@ I do know there is a addon like this already in development, check it out at the
 
 To install the addon download the source files and put the "addons" folder on a root level to your project. After that enable the plugin via the Godot plugin menu.
 
-Checkout this part of the [Godot documentation][installing-and-enable-plugin]
+Checkout this part of the [Godot documentation][installing-and-enable-plugin].
+
+> :warning: If you install the plugin and it is not active it is possible that godot will throw errors that the identifier "Console" cannot be found. To fix this issues you just need to activate the plugin, this error is a result of an dependency to that global instance, which is not present after install throwing an error on Godot automatic code check.
+
+![Installation error](https://i.imgur.com/5HuV62g.png)
+*Error listed because Console is not loaded just yet, this is normal*
 
 ## Quickstart
 

addons/gameconsole/builtin/command_help.gd

@@ -1,5 +1,15 @@
 extends CommandTemplate
 
+var list_command_executer: Interaction
+var enter_man_command: Interaction
+
+func _init():
+    list_command_executer = Interaction.new()
+    list_command_executer.from_raw("execute", "list_commands")
+    
+    enter_man_command = Interaction.new()
+    enter_man_command.from_raw("enter", "man")
+
 func create_command() -> Command:
     var command = Command.new("help", _get_help, [], "Get help for this console")
     return command
@@ -13,10 +23,10 @@ func _get_help() -> String:
     var return_data = "[center][b]%s[/b] by %s[/center]\n" % [addon_name, author_name] \
                     + "[center]%s[/center]\n" % version \
                     + _get_description() \
-                    + "[center][url={\"type\": \"execute\", \"command\": \"list_commands\"}]List commands[/url][/center]"
+                    + "[center][url=%s]List commands[/url][/center]" % list_command_executer.get_as_string()
     return return_data
 
 func _get_description() -> String:
     return "[center]This addon does allow you to run built in or custom commands for your game.\n" \
-    + " If you need help run the [url={\"type\": \"enter\", \"command\": \"man\"}]man[/url] command followed by the command you need help with.\n" \
+    + " If you need help run the [url=%s]man[/url] command followed by the command you need help with.\n" % enter_man_command.get_as_string() \
     + " Also if text is underlined you might be able to click it, test the \"[u]List Commands[/u]\" below [/center]\n\n"

addons/gameconsole/console/command/command.gd

@@ -10,6 +10,10 @@ var examples: PackedStringArray
 var is_hidden: bool = false
 var built_in: bool = false
 
+var self_man_link: Interaction
+var self_enter_link: Interaction
+var self_example_links := {}
+
 func _init(command_name: String,
 		   functionality: Callable,
 		   in_arguments : PackedStringArray = [],
@@ -23,6 +27,16 @@ func _init(command_name: String,
 	short_description = command_description
 	description = long_description
 	examples = command_examples
+	self_man_link = Interaction.new()
+	self_enter_link = Interaction.new()
+
+	self_man_link.from_raw("man", command)
+	self_enter_link.from_raw("enter", command)
+
+	for example in examples:
+		var example_link = Interaction.new()
+		example_link.from_raw("enter", example)
+		self_example_links[example] = example_link
 
 func get_command_name() -> String :
 	return command
@@ -34,7 +48,7 @@ func execute(arguments: Array) -> String:
 	return data
 
 func get_self_listed():
-	var url_part = "[url={\"type\": \"man\", \"command\": \"%s\"}]" % command
+	var url_part = "[url=%s]" % self_man_link.get_as_string()
 	var return_data = "- %s%s %s[/url]" % [url_part, get_command_name(), get_arguments()]
 	if short_description != "":
 		return_data += " => %s" % short_description
@@ -55,7 +69,7 @@ func as_stripped() -> StrippedCommand:
 	return return_data
 
 func get_man_page() -> String:
-	var command_url = "[url={\"type\": \"enter\", \"command\": \"%s\"}]" % command
+	var command_url = "[url=%s]" % self_enter_link.get_as_string()
 	var return_text = "%s[b]%s[/b][/url]\n\n" % [command_url, command]
 	var description_to_show = description
 	if description_to_show == "":
@@ -68,7 +82,8 @@ func get_man_page() -> String:
 	if examples.size() > 0:
 		return_text += "\n[i][b]Examples[/b][/i]\n"
 		for example in examples:
-			var example_url = "[url={\"type\": \"enter\", \"command\": \"%s\"}]" % example
+			var link = self_example_links[example] as Interaction
+			var example_url = "[url=%s]" % link.get_as_string()
 			return_text += "- %s%s[/url]\n" % [example_url, example]
 
 	return return_text

addons/gameconsole/console/console.gd

@@ -7,6 +7,8 @@ signal console_output(text: String)
 signal is_current_command_valid(confirmed: bool)
 signal copy_command_to_input(command: String)
 
+signal unknown_interaction_request(interaction: Interaction)
+
 @onready var console_template: PackedScene = preload("res://addons/gameconsole/console/console/default_console_template.tscn")
 var config_file = "res://addons/gameconsole/plugin.cfg"
 var _plugin_config: ConfigFile = null
@@ -232,11 +234,15 @@ func get_specific_command(command_name: String) -> Command:
 		return null	
 	return _console_commands[command_name]
 
-func url_requested(data: Dictionary):
-	match  data.type:
+func url_requested(interaction: Interaction):
+	match  interaction.get_type():
+		"UNKNOWN":
+			search_and_execute_command("man list_commands")
 		"man":
-			search_and_execute_command("man %s" % data.command)
+			search_and_execute_command("man %s" % interaction.get_data())
 		"enter":
-			copy_command_to_input.emit(data.command)		
+			copy_command_to_input.emit(interaction.get_data())		
 		"execute":
-			search_and_execute_command(data.command)
+			search_and_execute_command(interaction.get_data())
+		_:
+			unknown_interaction_request.emit(interaction)

addons/gameconsole/console/console/console_output.gd

@@ -4,6 +4,7 @@ var _stored_text: String = ""
 
 func _ready():
 	bbcode_enabled = true
+	meta_clicked.connect(_scroll_down)
 
 func append_bbcode_text(text: String):
 	append_text(text)
@@ -14,4 +15,7 @@ func get_stored_text() -> String:
 
 func clear_stored_text():
 	_stored_text = ""
-	clear()
+	clear()
+
+func _scroll_down(_data):
+	scroll_to_line(get_line_count() - 1)

addons/gameconsole/console/console/console_template.gd

@@ -5,7 +5,7 @@ signal output_append(text: String)
 signal store_content(text: String)
 signal confirm_command(text: String)
 signal is_command_valid(confirmed: bool)
-signal url_meta_requested(data: Dictionary)
+signal url_meta_requested(interaction: Interaction)
 signal set_input(command: String)
 signal clear_output()
 signal clear_input()
@@ -78,4 +78,6 @@ func url_requested(data):
 		Console.print_as_error("url data was not correctly parsed")
 		return
 	var dictionary = json_parser.get_data()
-	url_meta_requested.emit(dictionary)
+	var interaction = Interaction.new()
+	interaction.from_dictionary(dictionary)
+	url_meta_requested.emit(interaction)

addons/gameconsole/interactive/interaction.gd

@@ -0,0 +1,43 @@
+class_name Interaction extends Resource
+
+var _type: String
+var _data: String
+var _additional_data: Dictionary
+
+var _json_data: String
+
+## Parse an existing dictionary into an interaction object
+func from_dictionary(data: Dictionary):
+    _type = data.get_or_add("type", "UNKNOWN")
+    _data = data.get_or_add("data", "not_found")
+    _additional_data = data.get_or_add("additional", {})
+
+## Fill the information from raw information
+func from_raw(type: String, data: String, additional_data: Dictionary = {}):
+    _type = type
+    _data = data
+    _additional_data = additional_data
+    
+## Get the type of the current interaction
+func get_type() -> String:
+    return _type
+
+## Get the stored data for the current interaction
+func get_data() -> String:
+    return _data
+
+func get_additional_data() -> Dictionary:
+    return _additional_data
+
+func get_as_string() -> String:
+    if _json_data:
+        return _json_data
+    var result = {
+        "type": _type,
+        "data": _data,
+    }
+    if !_additional_data.is_empty():
+        result.additional = _additional_data
+     
+    var _json_data = JSON.stringify(result)
+    return _json_data

addons/gameconsole/plugin.cfg

@@ -3,5 +3,5 @@
 name="Game Console"
 description="Addon to add a console to the game, allowing you to register and run commands."
 author="Xanatos"
-version="0.2.0"
+version="0.3.0"
 script="gameconsole.gd"

example/console_example.gd

@@ -14,6 +14,7 @@ var counter: int = 0
 # Called when the node enters the scene tree for the first time.
 func _ready() -> void:
 	_register_commands()
+	Console.unknown_interaction_request.connect(_handle_unknown_interaction)
 	if always_use_custom_console:
 		Console.set_custom_command_template(custom_console_template)
 
@@ -71,11 +72,31 @@ func _spawn_entity(pos_x: String, pos_y: String, ttl: String) -> String:
 	var real_y = int(pos_y)
 	var real_ttl = float(ttl)
 
-	var target_position = Vector2(real_x, real_y)
-	var new_node = EntityExample.new(target_position, real_ttl)
-	add_child(new_node)
+	_trigger_spawn_entity(real_x, real_y, real_ttl)
+
+	var custom_interaction = Interaction.new()
+	var custom_edit = Interaction.new()
+
+	# The second parameter would be some identifier to find entity to spawn
+	custom_interaction.from_raw("spawn_entity", "entity_example", {
+		"x": real_x,
+		"y": real_y,
+		"ttl": real_ttl
+	})
 
-	return "Spawn entity at (%s/%s) with a ttl or %s" % [real_x, real_y, real_ttl]
+	custom_edit.from_raw("enter", "spawn_entity %s %s %s" % [pos_x, pos_y, ttl])
+
+	return "Spawn entity at (%s/%s) with a ttl of %s [url=%s]retrigger[/url] or [url=%s]edit[/url]" % [real_x,
+																									   real_y,
+																									   real_ttl,
+																									   custom_interaction.get_as_string(),
+																									   custom_edit.get_as_string()
+																									  ]
+
+func _trigger_spawn_entity(x: int, y: int, ttl: float):
+	var target_position = Vector2(x, y)
+	var new_node = EntityExample.new(target_position, ttl)
+	add_child(new_node)
 
 func _reload() -> String:
 	get_tree().reload_current_scene()
@@ -107,6 +128,18 @@ func _open_default_console():
 	Console.hide_console()
 	Console.show_console()
 
+func _handle_unknown_interaction(interaction: Interaction):
+	match interaction.get_type():
+		"spawn_entity":
+			## In theory this would be the entity we want to spawn, this is added just for demo purpose
+			var _entity_name = interaction.get_data()
+			var x = interaction.get_additional_data().get_or_add("x", 0)
+			var y = interaction.get_additional_data().get_or_add("y", 0)
+			var ttl = interaction.get_additional_data().get_or_add("ttl", 0)
+
+			_trigger_spawn_entity(x, y, ttl)
+
+
 func _unregister_commands():
 	# Should be done if scene gets unloaded to prevent broken commands
 	Console.remove_command("count_up")

example/custom_console_template.tscn

@@ -66,9 +66,11 @@ command_input = NodePath("../VBoxContainer/ConsoleInput")
 [connection signal="clear_output" from="." to="PanelContainer/MarginContainer/VBoxContainer/ConsoleOutput" method="clear_stored_text"]
 [connection signal="is_command_valid" from="." to="PanelContainer/MarginContainer/VBoxContainer/HBoxContainer/VBoxContainer/ConsoleInput" method="is_command_valid"]
 [connection signal="output_append" from="." to="PanelContainer/MarginContainer/VBoxContainer/ConsoleOutput" method="append_bbcode_text"]
+[connection signal="set_input" from="." to="PanelContainer/MarginContainer/VBoxContainer/HBoxContainer/VBoxContainer/ConsoleInput" method="autocomplete_accepted"]
+[connection signal="meta_clicked" from="PanelContainer/MarginContainer/VBoxContainer/ConsoleOutput" to="." method="url_requested"]
 [connection signal="autocomplete_accepted" from="PanelContainer/MarginContainer/VBoxContainer/HBoxContainer/VBoxContainer/ConsoleAutocomplete" to="PanelContainer/MarginContainer/VBoxContainer/HBoxContainer/VBoxContainer/ConsoleInput" method="autocomplete_accepted"]
-[connection signal="text_changed" from="PanelContainer/MarginContainer/VBoxContainer/HBoxContainer/VBoxContainer/ConsoleInput" to="." method="check_if_is_valid_command"]
 [connection signal="text_changed" from="PanelContainer/MarginContainer/VBoxContainer/HBoxContainer/VBoxContainer/ConsoleInput" to="." method="autocomplete_requested"]
+[connection signal="text_changed" from="PanelContainer/MarginContainer/VBoxContainer/HBoxContainer/VBoxContainer/ConsoleInput" to="." method="check_if_is_valid_command"]
 [connection signal="text_changed" from="PanelContainer/MarginContainer/VBoxContainer/HBoxContainer/VBoxContainer/ConsoleInput" to="PanelContainer/MarginContainer/VBoxContainer/HBoxContainer/VBoxContainer/ConsoleAutocomplete" method="text_updated"]
 [connection signal="text_submitted" from="PanelContainer/MarginContainer/VBoxContainer/HBoxContainer/VBoxContainer/ConsoleInput" to="." method="request_command"]
 [connection signal="request_command" from="PanelContainer/MarginContainer/VBoxContainer/HBoxContainer/ConsoleSendButton" to="." method="request_command"]