From 909773a65b32327f6d9af20fb1d80c556d75b9f0 Mon Sep 17 00:00:00 2001 From: John Breaux Date: Fri, 22 Oct 2021 01:53:04 -0500 Subject: [PATCH] Improve debug and Options somewhat --- godot_ship/project.godot | 14 +- godot_ship/scenes/Debug Menu.tscn | 7 + godot_ship/scenes/Options.tscn | 10 +- godot_ship/script/debug/In.gd | 3 + godot_ship/script/debug/debug_menu.gd | 336 +++++++++++++++++++------- godot_ship/script/game/Main.gd | 4 +- godot_ship/script/options/Options.gd | 2 +- 7 files changed, 278 insertions(+), 98 deletions(-) diff --git a/godot_ship/project.godot b/godot_ship/project.godot index 2b0210e..e18a4ad 100644 --- a/godot_ship/project.godot +++ b/godot_ship/project.godot @@ -58,11 +58,23 @@ ui_down={ , Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":83,"unicode":0,"echo":false,"script":null) ] } -ui_debug={ +ui_debug_open={ "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":96,"unicode":0,"echo":false,"script":null) ] } +ui_debug_up={ +"deadzone": 0.5, +"events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777232,"unicode":0,"echo":false,"script":null) +, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":0,"button_index":12,"pressure":0.0,"pressed":false,"script":null) + ] +} +ui_debug_down={ +"deadzone": 0.5, +"events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777234,"unicode":0,"echo":false,"script":null) +, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":0,"button_index":13,"pressure":0.0,"pressed":false,"script":null) + ] +} ui_rotate={ "deadzone": 0.5, "events": [ Object(InputEventMouseButton,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"button_mask":0,"position":Vector2( 0, 0 ),"global_position":Vector2( 0, 0 ),"factor":1.0,"button_index":2,"pressed":false,"doubleclick":false,"script":null) diff --git a/godot_ship/scenes/Debug Menu.tscn b/godot_ship/scenes/Debug Menu.tscn index 8bb1fa2..f4b6c46 100644 --- a/godot_ship/scenes/Debug Menu.tscn +++ b/godot_ship/scenes/Debug Menu.tscn @@ -45,6 +45,12 @@ script = ExtResource( 4 ) margin_top = 146.0 margin_right = 640.0 margin_bottom = 170.0 +focus_neighbour_left = NodePath(".") +focus_neighbour_top = NodePath(".") +focus_neighbour_right = NodePath(".") +focus_neighbour_bottom = NodePath(".") +focus_next = NodePath(".") +focus_previous = NodePath(".") max_length = 256 placeholder_text = "By your command." caret_blink = true @@ -52,5 +58,6 @@ script = ExtResource( 3 ) [connection signal="clear_in" from="." to="debug_canvas/VBoxContainer/LineEdit" method="_on_Debug_clear_in"] [connection signal="clear_out" from="." to="debug_canvas/VBoxContainer/TextEdit" method="_on_Debug_clear_out"] +[connection signal="history_event" from="." to="debug_canvas/VBoxContainer/LineEdit" method="_on_Debug_history_event"] [connection signal="print_text" from="." to="debug_canvas/VBoxContainer/TextEdit" method="_on_Debug_print_text"] [connection signal="text_entered" from="debug_canvas/VBoxContainer/LineEdit" to="." method="_on_LineEdit_text_entered"] diff --git a/godot_ship/scenes/Options.tscn b/godot_ship/scenes/Options.tscn index a113710..66c058d 100644 --- a/godot_ship/scenes/Options.tscn +++ b/godot_ship/scenes/Options.tscn @@ -94,8 +94,8 @@ margin_top = -8.0 margin_right = 208.0 margin_bottom = 8.0 focus_neighbour_top = NodePath("../../SFX Setting/SFX Slider") -focus_neighbour_bottom = NodePath("../../../Theme Select") -focus_next = NodePath("../../../Theme Select") +focus_neighbour_bottom = NodePath("../../../Buttons/Dark") +focus_next = NodePath("../../../Buttons/Dark") focus_previous = NodePath("../../SFX Setting/SFX Slider") step = 10.0 tick_count = 11 @@ -141,10 +141,12 @@ margin_left = 16.0 margin_top = 16.0 margin_right = 28.0 margin_bottom = 36.0 -focus_neighbour_left = NodePath("../Sliders/SFX Setting/SFX Slider") +focus_neighbour_left = NodePath(".") focus_neighbour_top = NodePath(".") -focus_neighbour_right = NodePath(".") +focus_neighbour_right = NodePath("../Sliders/SFX Setting/SFX Slider") focus_neighbour_bottom = NodePath("../Buttons/Light") +focus_next = NodePath("../Sliders/SFX Setting/SFX Slider") +focus_previous = NodePath(".") text = "Back" __meta__ = { "_edit_lock_": true, diff --git a/godot_ship/script/debug/In.gd b/godot_ship/script/debug/In.gd index 4615a9a..61c7c21 100644 --- a/godot_ship/script/debug/In.gd +++ b/godot_ship/script/debug/In.gd @@ -2,3 +2,6 @@ extends LineEdit func _on_Debug_clear_in(): clear() + +func _on_Debug_history_event(history): + text = history; diff --git a/godot_ship/script/debug/debug_menu.gd b/godot_ship/script/debug/debug_menu.gd index c8cc594..03eeb74 100644 --- a/godot_ship/script/debug/debug_menu.gd +++ b/godot_ship/script/debug/debug_menu.gd @@ -1,6 +1,5 @@ extends Control -# Declare member variables here. var debug_output var debug_line = 0 @@ -11,6 +10,58 @@ var debug_active = false var menu_position = 0.0 var menu_velocity = 4 +var history = [] +var history_pos = 0 + +# helptext: args list and help blurb accessed by function name +var helptext = { +# command_id [args "Help text" ] + "command_help": [" [command]", "Print information about command.\n" ], + "command_history": ["", "Print the history log.\n" ], + "command_perf": [" stat", "Print performance info (fps, nodes, proctime, ... )\n" ], + + "command_list": [" [path]", "List children of path, or of present working node.\n" ], + "command_start": [" filename", "Load PackedScene filename.tscn as child.\n" ], + "command_kill": [" name", "Kill child node with matching name.\n" ], + + "command_pwd": ["", "Print the Present Working Node.\n" ], + "command_cd": [" path", "Change the Present Working Node to path.\n" ], + + "command_print": [" string", "Print string to the in-game debug console.\n" ], + "command_clear": ["", "Clear the debug output.\n" ], + + "command_emit": [" signal [message]", "Emit a message on MessageBus.signal without validation.\n"], + "command_call": [" func [args ...]", "Call func(...) with arguments args.\n" ], + + "command_restart": ["", "Kill the current scene tree and plant a new Root.\n" ], + "command_exit": ["", "Quits the program.\n" ], +} + +# List of debug commands accessed by alias +# The first alias is the canonical alias, aka command name +var commands = { +# [alias array]: "func_name" + ["help", "h"]: "command_help", + ["hist", "history"]: "command_history", + ["perf", "performance"]: "command_perf", + + ["list", "ls", "l"]: "command_list", + ["start", "open", "o"]: "command_start", + ["kill", "stop", "k"]: "command_kill", + + ["pwd", "pwn"]: "command_pwd", + ["cd", "cn"]: "command_cd", + + ["print", "p"]: "command_print", + ["clear","cls"]: "command_clear", + + ["emit", "e"]: "command_emit", + ["call", "func"]: "command_call", + + ["restart", "killall"]: "command_restart", + ["exit", "quit"]: "command_exit", + } + onready var present_working_node = get_node("/root/Main") # positions when the menu is hidden/active @@ -18,11 +69,19 @@ var menu_hidden = Transform2D(Vector2(1,0), Vector2(0,1), Vector2(0,-170)) var menu_active = Transform2D(Vector2(1,0), Vector2(0,1), Vector2(0, 0)) # signals -signal clear_in # clears the debug input -signal clear_out # clears the debug output -signal print_text(text) # Sends text for printing to the Out buffer +# clear_in: clear the debug input +signal clear_in +# clear_out: clear the debug output +signal clear_out +# print_text(text): Send text to the Out buffer +signal print_text(text) +# history_event(text): Send text to the In buffer +signal history_event(text) -# Called when the node enters the scene tree for the first time. +# Inherited functions: +# _ready: Called when the node enters the scene tree for the first time. +# params: none +# returns: void func _ready(): debug_canvas = get_node("debug_canvas") debug_transform = debug_canvas.get_transform() @@ -30,7 +89,9 @@ func _ready(): command_help([""]) debug_print_line("> ") -# Called every frame. 'delta' is the elapsed time since the previous frame. +# _process: Called every frame. Controls slide-in animation and focus-grabbing +# params: delta: elapsed time +# returns: void func _process(delta): if (debug_active && menu_position < 1): # Move the menu down @@ -46,47 +107,109 @@ func _process(delta): debug_canvas.set_transform(menu_hidden.interpolate_with(menu_active, menu_position)) +# _input: Process user input related to the debug menu +# params: event: The input event which triggered _input call +# returns: void func _input(event): - if event.is_action_pressed("ui_debug"): + if event.is_action_pressed("ui_debug_open"): # open debug menu debug_active = !debug_active; # Hand the keyboard focus to the next valid focus if (!debug_active) && find_next_valid_focus(): find_next_valid_focus().grab_focus() + if event.is_action_pressed("ui_debug_up") and debug_active: + #traverse history up + history_move(-1) + pass + if event.is_action_pressed("ui_debug_down") and debug_active: + #traverse history down + history_move(+1) +# Signal-processing functions: +# _on_LineEdit_text_entered: process incoming text line +# params: line: Line of text entered by user +# returns: void func _on_LineEdit_text_entered(line): + history_append(line) emit_signal("clear_in") debug_print_line(line + "\n") var command = line.split(' ', true, 1) - match command[0]: - "start", "open", "o": - command_start(command) - "stop", "kill", "k": - command_stop(command) - "list", "ls", "l": - command_list(command) - "restart", "killall": - command_restart(command) - "print", "p": - command_print(command) - "raw_emit", "emit", "r", "e": # Send a signal over the MessageBus - command_emit(command) - "clear","cls": # Clear the output - command_clear(command) - "help", "h": - command_help(command) - "pwd", "pwn": - command_pwd(command) - "cd", "cn": - command_cd(command) - _: - debug_print_line("Command not recognized.\n") + var command_func = parse(command[0]) + if command_func: + call(command_func, command) + else: + debug_print_line("dbg: command not found: " + command[0] + "\n") debug_print_line("> ") +# History_related helper functions: +func history_append(text): + history.resize(history_pos + 2) + history[history_pos] = text + history_pos += 1 + +func history_move(direction): + if history_pos + direction < 0: + pass + elif history_pos + direction >= history.size(): + pass + else: + history_pos += direction; + if history[history_pos]: + emit_signal("history_event", history[history_pos]) + else: + emit_signal("clear_in") + +# Debug-related helper functions: +# debug_print_line: request printing of c-escaped text to debug output +# params: string: Text string to print +# returns: void func debug_print_line(string): emit_signal("print_text", string.c_unescape()) -# Commands +# complete_path: complete a relative or absolute path, and returns the node it refers to +# params: path: relative or absolute path to a node +# returns: void +func complete_path(path): + if path.is_rel_path(): # convert to absolute path + path = String(present_working_node.get_path()) + "/" + path + var node = get_node(path) + if node: + return node + return null +# Command-lookup functions: +# parse: parse command name and return associated func name +# params: alias: alias of a command +# returns: name of command function +func parse(alias): + var key = lookup(alias) + if key: + return commands[key] + return null + +# name_lookup: find key associated with function name +# params: command_name: alias of a command +# returns: key: Array containing all aliases of the given command +func lookup(alias): + for key in commands.keys(): + if alias in key: + return key + return null + +# get_canonical: find the canonical name for a command +# params: alias: alias of a command +# returns: name: canonical name for a command +func get_canonical(alias): + var names = lookup(alias) + if names: + return names[0] + return null + +# get_usage: Construct the usage string for a command +func get_usage(alias): + return "Usage: " + alias + helptext[parse(alias)][0] + "\n" + +# Commands. All commands take in a parameter called command, +# which contains a partially tokenized command # start: Loads scene from res://scenes/*.tscn by filename, and starts it func command_start (command): if command.size() > 1: @@ -94,10 +217,10 @@ func command_start (command): present_working_node.add_child(pack.instance()); debug_print_line("start '" + command[1] + "'\n") else: - debug_print_line("Usage: start scene") + debug_print_line(get_usage(command[0])) # stop: kills a child of current working node -func command_stop (command): +func command_kill (command): if command.size() > 1: var node = present_working_node.find_node(command[1], false, false) if node: @@ -109,7 +232,7 @@ func command_stop (command): else: debug_print_line(command[0] + ": " + command[1] + " not found.\n") else: - debug_print_line("Usage: kill name\n") + debug_print_line(get_usage(command[0])) # list: Lists children of node func command_list (command): @@ -137,80 +260,111 @@ func command_print(command): # emit: emits a message onto the MessageBus func command_emit (command): - var mbus_signal = command[1].split(' ', true, 1) - match mbus_signal.size(): - 2: - debug_print_line("Message: " + String(mbus_signal) + "\n") - MessageBus.emit_signal(mbus_signal[0], mbus_signal[1]) - 1: - debug_print_line("Message: " + String(mbus_signal) + "\n") - MessageBus.emit_signal(mbus_signal[0]) - 0: debug_print_line( "Usage: raw_emit signal [value]\n") + if command.size() > 1: + var mbus_signal = command[1].split(' ', true, 1) + match mbus_signal.size(): + 2: + debug_print_line("Message: " + String(mbus_signal) + "\n") + MessageBus.emit_signal(mbus_signal[0], mbus_signal[1]) + 1: + debug_print_line("Message: " + String(mbus_signal) + "\n") + MessageBus.emit_signal(mbus_signal[0]) + 0: debug_print_line(get_usage(command[0])) + else: + debug_print_line(get_usage(command[0])) # clear: clears the debug output func command_clear (_command): emit_signal("clear_out"); -# pwd: print the current working node's path +# pwd: print the present working node's path func command_pwd (_command): debug_print_line(String(present_working_node.get_path()) + "\n") -# cd: change the current working node + +# cd: change the present working node func command_cd (command): if command.size() > 1: var node = complete_path(command[1]) if node: present_working_node = node else: - debug_print_line ('cn: no such node: ' + command[1] + '\n') + debug_print_line (get_canonical(command[0]) + ': no such node: ' + command[1] + '\n') else: - debug_print_line("") - pass + debug_print_line(get_usage(command[0])) # help: Prints help dialogue func command_help (command): if (command.size() == 1): - debug_print_line("Valid commands:\nhelp, start, stop, list, restart, print, emit, clear, pwn, cn\n") + debug_print_line("Valid commands:\n") + for key in commands: + debug_print_line(key[0] + " ") + debug_print_line("\n") else: - debug_print_line(command[1]) - match command[1]: - "start", "open", "o": - debug_print_line(" filename\nAliases: 'start', 'open', 'o'\n") - debug_print_line("Load add the scene filename.tscn as child\n") - "stop", "kill", "k": - debug_print_line(" name\nAliases: 'stop', 'kill', 'k'\n") - debug_print_line("Kill node with matching name\n") - "list", "ls", "l": - debug_print_line(" [path]\nAliases: 'list', 'ls', 'l'\n") - debug_print_line("List node children\n") - "restart", "killall": - debug_print_line("\nAliases: 'restart', 'killall'\n") - debug_print_line("Kill the current scene tree and plant a new Root.\n") - "print", "p": - debug_print_line(" string\nAliases: 'print', 'p'\n") - debug_print_line("Prints a string to the in-game debug console\n") - "raw_emit", "emit", "r", "e": - debug_print_line(" signal [message]\nAliases: 'raw_emit', 'emit', 'r', 'e'\n") - debug_print_line("Puts a message on the MessageBus without validation.\n") - "clear","cls": - debug_print_line("\nAliases: 'clear', 'cls'\n") - debug_print_line("Clears the debug output.\n") - "help", "h": - debug_print_line(" [command]\nAliases: 'help', 'h'\n") - debug_print_line("Prints information about a command.\n") - "pwd", "pwn": - debug_print_line("\nAliases: 'pwn', 'pwd'\n") - debug_print_line("Prints the Present Working Node.\n") - "cd", "cn": - debug_print_line(" path/to/node\nAliases: 'cn', 'cd'\n") - debug_print_line("Change the Present Working Node.\n") - _: - debug_print_line(command[1] + "\nIsn't a valid command\n") + var command_func = parse(command[1]) + var aliases + var text + if command_func in helptext: + text = helptext[command_func] + aliases = lookup(command[1]) + debug_print_line(command[1] + text[0] + ":\n Aliases: " + String(aliases) + "\n "+ text[1]) + else: + debug_print_line(get_canonical(command[0]) + ": command not found: " + command[1] + "\n") -# Completes a relative or absolute path, and returns the node it refers to -func complete_path(path): - if path.is_rel_path(): # convert to absolute path - path = String(present_working_node.get_path()) + "/" + path - var node = get_node(path) - if node: - return node - return null +# exit: request program exit +func command_exit(_command): + MessageBus.emit_signal("quit") + +# call: call arbitrary member function of present working node +func command_call(command): + if command.size() > 1: + var call_ret = null + var call_args = [] + var call_cmd = command[1].split(' ', true, 1) + if call_cmd.size() > 1: + call_args = call_cmd[1].split(' ', false, 0) + if present_working_node.has_method(call_cmd[0]): + call_ret = present_working_node.callv(call_cmd[0], call_args) + else: + debug_print_line("We're sorry, but your call could not be completed as dialed.\n" + + "Please hang up and try your call again.\n") + return + if (call_ret): + debug_print_line("'" + String(call_ret) + "'\n") + else: + debug_print_line("null\n") + else: + debug_print_line(get_usage(command[0])) + +func command_history(_command): + var lnum = 0 + for line in history: + if line: + debug_print_line(String(lnum) + ": " + line + "\n") + lnum += 1 + debug_print_line("history_pos = " + String(history_pos) + "\n") + +func command_perf(command): + if command.size() > 1: + var stat = perf(command[1]) + if stat: + debug_print_line(String(stat) + "\n") + else: + debug_print_line("null\n") + else: + debug_print_line(get_usage(command[0])) + +func perf(attribute): + if attribute.is_valid_integer(): + return Performance.get_monitor(int(attribute)) + match attribute: + "fps": + return Performance.get_monitor(Performance.TIME_FPS) + "proctime": + return Performance.get_monitor(Performance.TIME_PROCESS) + "objects": + return Performance.get_monitor(Performance.OBJECT_COUNT) + "nodes": + return Performance.get_monitor(Performance.OBJECT_NODE_COUNT) + "resources": + return Performance.get_monitor(Performance.OBJECT_RESOURCE_COUNT) + return "" diff --git a/godot_ship/script/game/Main.gd b/godot_ship/script/game/Main.gd index 344ecee..84e5b39 100644 --- a/godot_ship/script/game/Main.gd +++ b/godot_ship/script/game/Main.gd @@ -7,6 +7,7 @@ var options var debug_menu var debug_enabled = true +var start_fullscreen = false # Called when the node enters the scene tree for the first time. func _ready(): @@ -24,7 +25,8 @@ func _ready(): options = preload("res://scenes/Options.tscn") debug_menu = preload("res://scenes/Debug Menu.tscn") # go fullscreen - OS.window_fullscreen = true + if start_fullscreen: + OS.window_fullscreen = true if debug_enabled: add_child(debug_menu.instance()) diff --git a/godot_ship/script/options/Options.gd b/godot_ship/script/options/Options.gd index 3198264..3644068 100644 --- a/godot_ship/script/options/Options.gd +++ b/godot_ship/script/options/Options.gd @@ -14,7 +14,7 @@ func _ready(): func _on_Button_pressed(): queue_free() - MessageBus.emit_signal("change_scene", "Title") +# MessageBus.emit_signal("change_scene", "Title") func _on_SFX_Slider_value_changed(value):