Add custom built in script, command precalls, array and dictionary support by ZRavyyy · Pull Request #9 · limbonaut/limbo_console

ZRavyyy · 2025-02-07T21:50:46Z

Explanation of added features:

Custom built-in script

It is the link between the game (or any project), and the console itself. It is very convenient to add commands in it, without cluttering the scripts of your game.

Initialized before autoexec script is called, so not only built-in commands can be used in autoexec script.

Example:

extends Node
## Custom builtin script

func _init() -> void:
    Console.unregister_command("eval")

    Console.register_command(cmd_test)
    Console.register_command_precall(_precall, cmd_test)

func _precall(p_func: Callable, p_args: Array):
    if not World.is_in_world:
        Console.error("Console works only in world")
        return FAILED
    else:
        return p_func.callv(p_args)

func cmd_test(text: String, vec2: Vector2, arr: Array, dict: Dictionary) -> void:
	Console.info("text: %s\nvec2: %s\narr: %s\ndict: %s" % [text, vec2, arr, dict])

Command precall

Called before the function call. Can be used for its own checks before calling a function.

Personally, I need this function to check players for rights, let's say access to the command kick, spawn, set_time should get only privileged players, and only if the player is in the world, and to check in each function whether the player has rights clutters the real function with a lot of checks. That's why I consider precall a necessary function, at least in multiplayer.

Array and Dictionary

Well, this needs no explanation. You can now enter arrays, dictionaries, sub-arrays, sub-subarrays, etc. into the console.

Unsafe

Now you can enable unsafe conversion (of arrays, vectors and dictionaries) in the console config file.

Enabling unsafe conversion may increase the speed of console commands, but hits security significantly due to unchecked initialization of vectors, arrays, and dictionaries, which could potentially include auto-initializing script (theoretically).

This may not be very useful in normal cases, but in situations where you need to process a huge array or dictionary, it will significantly speed up the processing of the command

Script now no more need _start to init

limbonaut · 2025-02-09T14:50:48Z

That's a lot of stuff. Thanks for submitting! I'll need some time to review it.

limbonaut

Thanks for submitting your contribution. There are a few things that need some work before I can give it the green light.

limbonaut · 2025-03-15T11:24:18Z

console_options.gd

+## but it can also improve the speed of the console.
+## Enable parameters in this category only if you are not going to use the console online.
+@export_category("unsafe")
+@export var unsafe_conversion: bool = false


I'd rather cut the unsafe flag - it's not necessary. If something doesn't fit into performance expectations, we better optimize it instead.

My idea is that this should be used for huge commands that need to be processed without checking, otherwise checking the whole command could take a long time, but I'm not sure if it's really that useful.

limbonaut · 2025-03-15T11:26:25Z

limbo_console.gd

 const THEME_DEFAULT := "res://addons/limbo_console/res/default_theme.tres"
 const HISTORY_FILE := "user://limbo_console_history.log"
+# Custom builtin script support
+const CUSTOM_BUILTIN_SCRIPT := "res://addons/limbo_console.gd"


Built-in means something is included with the addon as a default feature. But this is a custom init script that users can add themselves. It should be in the options, and the default name shouldn’t be the same as the file we already have. I think we should move this to the options as init_script setting and not set any default value. That way, users can choose their own location if they need this.

limbonaut · 2025-03-15T11:28:48Z

limbo_console.gd



+# Custom builtin script support
+func _init_custom_builtin_script() -> void:


Something is either custom-made or built-in, not both.

I don’t think this functionality is absolutely necessary - we can use Autoloads to achieve the same thing. This basically gives us a special way to do what autoloads can already do. Perhaps, for autoexecs, is this something you need?

limbonaut · 2025-03-15T11:38:37Z

limbo_console.gd

+		elif char == '(' or char == '{' or char == '[':
+			brackets += char
+		elif char == ')' or char == '}' or char == ']':
+			if char == ')' and '(' in brackets:


I think it would be better to check if the opening bracket ( is the last character in the brackets string. This way, we can catch any issues with bracket ordering much earlier.

limbonaut · 2025-03-15T11:39:48Z

limbo_console.gd

+		elif char == ')' or char == '}' or char == ']':
+			if char == ')' and '(' in brackets:
+				brackets = brackets.erase(brackets.rfind('('))
+			elif char == '}' and '{' in brackets:


And same here.

limbonaut · 2025-03-15T12:36:53Z

limbo_console.gd

 	for arg in method_info.args:
-		if not arg.type in [TYPE_NIL, TYPE_BOOL, TYPE_INT, TYPE_FLOAT, TYPE_STRING, TYPE_VECTOR2, TYPE_VECTOR2I, TYPE_VECTOR3, TYPE_VECTOR3I, TYPE_VECTOR4, TYPE_VECTOR4I]:
+		if not arg.type in [TYPE_NIL, TYPE_BOOL, TYPE_INT, TYPE_FLOAT, TYPE_STRING, TYPE_VECTOR2, TYPE_VECTOR2I, TYPE_VECTOR3, TYPE_VECTOR3I, TYPE_VECTOR4, TYPE_VECTOR4I,\
+		# Dictionary support and Array support


Suggested change

# Dictionary support and Array support

limbonaut · 2025-03-15T12:39:45Z

limbo_console.gd

-	_hist_idx = wrapi(_hist_idx, -1, _history.size())
+	# Now scrolling stops when reaching the end or beginning of the history
+	_hist_idx = clampi(_hist_idx, -1, _history.size() - 1)
+	#_hist_idx = wrapi(_hist_idx, -1, _history.size())


Suggested change

#_hist_idx = wrapi(_hist_idx, -1, _history.size())

limbonaut · 2025-03-15T12:41:03Z

limbo_console.gd

+	var comp: Dictionary
+	var key = ""
+	var brackets: String
+	var token = ""


Suggested change

var token = ""

var token: Variant = ""

limbonaut · 2025-03-15T13:17:45Z

limbo_console.gd

 	if valid:
-		var err = cmd.callv(command_args)
+		# Command precalls support
+		var err


For clarity:

Suggested change

var err

var err: Variant

limbonaut · 2025-03-15T13:24:45Z

limbo_console.gd


+# Dictionary support
+func _parse_dictionary_arg(p_text: String):
+	assert(p_text.begins_with('{') and p_text.ends_with('}'), "Dictionary string presentation must begin and end with curly brackets")


Asserts are annoying - they interrupt execution and throw you into the code editor. Something I'd like to avoid.

Well, I saw that you use asserts in vectors, so I figured it was normal for you.

first check if the number is int, then check for float

…nto limbonaut-master

Limbonaut master

Own merge

limbonaut · 2026-02-15T16:58:23Z

I find it hard to come back to reviewing this PR because theres just too much mixed into it. I'd prefer changes to be split into atomic PRs, each dealing with one logical change or feature with corresponding README updates. Some things are naturally connected (like array and dictionary support share parsing logic), but this PR also mixes in the init script system, command precalls, and various unrelated tweaks. That's just too much scope for a single PR.

To be transparent about where each stands:

Array and dictionary: Most likely to land. I'd welcome a focused PR for just this.
Command precalls: I'm not convinced on the approach, and would want to discuss alternatives first.
Init script: I’m okay with it in principle (though it needs some adjustments), but it may eventually be replaced by a plugin system.

Thanks for the contribution, and sorry for the late response.

ZRavyyy and others added 8 commits February 8, 2025 00:07

builtin commit

7e93f7d

Update limbo_console.gd

3a46c1e

Script now no more need _start to init

fixes

f861ce7

register and unregister command precall

c133274

Update limbo_console.gd

a4c2b43

array fix

c194462

Update limbo_console.gd

0c89b37

Merge remote-tracking branch 'origin/master'

a3e00c0

limbonaut reviewed Mar 15, 2025

View reviewed changes

ZRavyyy and others added 12 commits April 11, 2025 15:33

modified as required

0ae6f13

array fix

2465d63

Update limbo_console.gd

3cd084a

first check if the number is int, then check for float

correctly open log files in debug and release mode

ba107a9

Merge branch 'master' of https://github.com/limbonaut/limbo_console i…

504b076

…nto limbonaut-master

merge from limbonaut

1818f95

Merge pull request #2 from ZRavyyy/limbonaut-master

fdc87ec

Limbonaut master

correctly open log files in debug and release mode

4f18d13

Merge branch 'limbonaut-master' into own

bda2294

merge from master

8a8d6cb

Merge pull request #3 from ZRavyyy/own

33a96a3

Own merge

main changes

f0c8c74



		# Custom builtin script support
		func _init_custom_builtin_script() -> void:

Uh oh!

Conversation

ZRavyyy commented Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Custom built-in script

Command precall

Array and Dictionary

Unsafe

Uh oh!

limbonaut commented Feb 9, 2025

Uh oh!

limbonaut left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

limbonaut Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

limbonaut commented Feb 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ZRavyyy commented Feb 7, 2025 •

edited

Loading

limbonaut Mar 15, 2025 •

edited

Loading