Initial commit. v1.0.0

Author: GustJc

.gitattributes

@@ -0,0 +1,7 @@
+# Normalize EOL for all files that Git considers text files.
+* text=auto eol=lf
+
+# Only include the addons folder when downloading from the Asset Library.
+/**        export-ignore
+/addons    !export-ignore
+/addons/** !export-ignore

.gitignore

@@ -0,0 +1,2 @@
+# Godot 4+ specific ignores
+.godot/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Gustavo Jaruga Cruz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,13 @@
+# Gdscript func finder shortcuts
+
+Very simple plugin that adds shortcuts to scroll to the previous and next func definitions.
+Inspired by PICO-8 script editor where you use the 'page up/down' keys to move acress functions.
+
+Shortcuts:
+- Page Up : Go to previous 'func'
+- Page Down : Go to next 'func'
+
+## TODO maybes
+
+Right now, it replaces the behavior of the 'page up' and 'page down' keys inside the script editor.
+I could add a proper shortcut configuration in the future instead.

addons/gdscript_func_finder/plugin.cfg

@@ -0,0 +1,7 @@
+[plugin]
+
+name="Gdscript func finder shortcuts"
+description="Makes page up and page down inside the script editor scroll to 'func' definitions."
+author="Gustjc"
+version="1.0.0"
+script="plugin_func_finder.gd"

addons/gdscript_func_finder/plugin_func_finder.gd

@@ -0,0 +1,69 @@
+@tool
+extends EditorPlugin
+
+var use_shift: bool = false ## Hold shift with page-up and page-down to scroll to funcs
+
+## Editor setting path
+const SCRIPT_USE_SHIFT: StringName = &"plugin/gdscript_func_finder/use_shift"
+
+
+func _enter_tree() -> void:
+	if ProjectSettings.has_setting(SCRIPT_USE_SHIFT):
+		use_shift = ProjectSettings.get_setting(SCRIPT_USE_SHIFT, use_shift)
+	else:
+		ProjectSettings.set_setting(SCRIPT_USE_SHIFT, use_shift)
+		ProjectSettings.set_initial_value(SCRIPT_USE_SHIFT, use_shift)
+		ProjectSettings.set_as_basic(SCRIPT_USE_SHIFT, true)
+
+	ProjectSettings.settings_changed.connect(sync_settings)
+
+
+func _exit_tree() -> void:
+	ProjectSettings.settings_changed.disconnect(sync_settings)
+
+
+func sync_settings() -> void:
+	use_shift = ProjectSettings.get_setting(SCRIPT_USE_SHIFT, use_shift)
+
+
+func _input(event: InputEvent) -> void:
+	if event is InputEventKey:
+		# Page Up
+		if event.keycode == KEY_PAGEUP and event.pressed and (!use_shift or event.shift_pressed):
+			var code_edit: CodeEdit = EditorInterface.get_script_editor().get_current_editor().get_base_editor()
+			if code_edit.has_focus():
+				move_prev_function(code_edit)
+				get_viewport().set_input_as_handled()
+
+		# Page down
+		if event.keycode == KEY_PAGEDOWN and event.pressed and (!use_shift or event.shift_pressed):
+			var code_edit: CodeEdit = EditorInterface.get_script_editor().get_current_editor().get_base_editor()
+			if code_edit.has_focus():
+				move_next_function(code_edit)
+				get_viewport().set_input_as_handled()
+
+
+func move_prev_function(code_edit: CodeEdit) -> void:
+	var caret_line = code_edit.get_caret_line()
+	var text_lines = code_edit.text.split("\n")
+
+	# Search backward for the function definition
+	for i in range(caret_line-1, -1, -1):
+		var line = text_lines[i].strip_edges()
+		if line.begins_with("func "):
+			code_edit.set_caret_line(i)
+			code_edit.set_caret_column(line.length())
+			return
+
+
+func move_next_function(code_edit: CodeEdit) -> void:
+	var caret_line = code_edit.get_caret_line()
+	var text_lines = code_edit.text.split("\n")
+
+	# Search fowards for the function definition
+	for i in range(caret_line+1, text_lines.size()):
+		var line = text_lines[i].strip_edges()
+		if line.begins_with("func "):
+			code_edit.set_caret_line(i)
+			code_edit.set_caret_column(line.length())
+			return

project.godot

@@ -0,0 +1,23 @@
+; Engine configuration file.
+; It's best edited using the editor UI and not directly,
+; since the parameters that go here are not all obvious.
+;
+; Format:
+;   [section] ; section goes between []
+;   param=value ; assign values to parameters
+
+config_version=5
+
+[application]
+
+config/name="Gdscript func finder pageup/down shortcuts"
+config/features=PackedStringArray("4.3", "Forward Plus")
+run/max_fps=60
+
+[dotnet]
+
+project/assembly_name="Gdscript func finder pageup-down shortcuts"
+
+[editor_plugins]
+
+enabled=PackedStringArray("res://addons/gdscript_func_finder/plugin.cfg")