gdharness 1.3.42 → 1.3.44

package/build/godot/addons/gdharness_editor/tools/navigation_bake.gd

@@ -1,6 +1,5 @@
 @tool
 extends RefCounted
-
 ## Bakes what a NavigationRegion2D or NavigationRegion3D in a scene file navigates by, as the
 ## editor's Bake button does, and saves it where the region keeps it.
 ##
@@ -13,10 +12,11 @@ extends RefCounted
 
 const GdhSceneFile = preload("../scene_file.gd")
 const GdhSceneUids = preload("../scene_uids.gd")
-
 ## The names NavigationPolygon.SourceGeometryMode and NavigationMesh.SourceGeometryMode give each
 ## mode, which share their values.
-const SOURCE_MODES: Array[String] = ["root_node_children", "groups_with_children", "groups_explicit"]
+const SOURCE_MODES: Array[String] = [
+	"root_node_children", "groups_with_children", "groups_explicit",
+]
 
 
 ## Bakes the region [param region] of [param scene], answering what it now holds or why not.
@@ -55,13 +55,16 @@ static func bake(scene: GdhSceneFile, region: Node) -> Dictionary:
 	var file: String = held.resource_path.get_slice("::", 0)
 	var embedded: bool = file.is_empty() or held.resource_path.contains("::")
 	if embedded and not file.is_empty() and file != scene.path:
-		return scene.refuse(
-			(
+		return (
+			scene
+			. refuse(
 				(
-					"The %s %s holds is built into %s, and a bake here cannot save that file. Bake the "
-					+ "region there, or save the %s to a file of its own."
+					(
+						"The %s %s holds is built into %s, and a bake here cannot save that file. "
+						+ "Bake the region there, or save the %s to a file of its own."
+					)
+					% [held.get_class(), at, file, held.get_class()]
 				)
-				% [held.get_class(), at, file, held.get_class()]
 			)
 		)
 
@@ -78,7 +81,8 @@ static func bake(scene: GdhSceneFile, region: Node) -> Dictionary:
 	}
 	if made:
 		answer["made"] = (
-			"%s held no %s, so one was made and built into the scene, with the defaults." % [at, property]
+			"%s held no %s, so one was made and built into the scene, with the defaults."
+			% [at, property]
 		)
 	if polygons == 0:
 		answer["note"] = _why_empty(held, flat, parsed)
@@ -86,17 +90,17 @@ static func bake(scene: GdhSceneFile, region: Node) -> Dictionary:
 		answer["note"] = _nothing_read(scene, held)
 	if not flat and not Engine.is_editor_hint() and _reads_meshes(region, held):
 		answer["meshesNote"] = (
-			"The engine's warning that it had to parse RenderingServer meshes at runtime is about a "
-			+ "game rebaking as it runs, where reading a mesh back from the GPU stalls a frame. A "
-			+ "headless engine gives it for any bake read from MeshInstance3D nodes; this one ran once "
-			+ "and is saved."
+			"The engine's warning that it had to parse RenderingServer meshes at runtime is about "
+			+ "a game rebaking as it runs, where reading a mesh back from the GPU stalls a frame. "
+			+ "A headless engine gives it for any bake read from MeshInstance3D nodes; this one "
+			+ "ran once and is saved."
 		)
 
 	if not embedded:
 		scene.close()
 		var saving: Error = GdhSceneUids.save_keeping_uid(held, file)
 		if saving != OK:
-			return {"ok": false, "error": "Failed to save %s: %s" % [file, error_string(saving)]}
+			return { "ok": false, "error": "Failed to save %s: %s" % [file, error_string(saving)] }
 		if Engine.is_editor_hint():
 			EditorInterface.get_resource_filesystem().update_file(file)
 		answer["savedTo"] = file
@@ -121,7 +125,9 @@ static func bake(scene: GdhSceneFile, region: Node) -> Dictionary:
 static func _parse_and_bake(scene: GdhSceneFile, at: String, held: Resource, flat: bool) -> bool:
 	var copy: Node = scene.root.duplicate(Node.DUPLICATE_GROUPS)
 	var reading: Resource = held.duplicate()
-	var group_property: String = "source_geometry_group_name" if flat else "geometry_source_group_name"
+	var group_property: String = (
+		"source_geometry_group_name" if flat else "geometry_source_group_name"
+	)
 	var group: String = str(held.get(group_property))
 	var own_group: String = "_gdh_bake_%d" % copy.get_instance_id()
 	reading.set(group_property, own_group)
@@ -136,8 +142,8 @@ static func _parse_and_bake(scene: GdhSceneFile, at: String, held: Resource, fla
 		var outline: NavigationPolygon = reading
 		var geometry: NavigationMeshSourceGeometryData2D = NavigationMeshSourceGeometryData2D.new()
 		NavigationServer2D.parse_source_geometry_data(outline, geometry, region)
-		# has_data() counts only traversable outlines, so a bake carving every obstacle it read would
-		# still say it read nothing.
+		# has_data() counts only traversable outlines, so a bake carving every obstacle it read
+		# would still say it read nothing.
 		found = (
 			not geometry.get_obstruction_outlines().is_empty()
 			or not geometry.get_projected_obstructions().is_empty()
@@ -211,12 +217,15 @@ static func _why_empty(held: Resource, flat: bool, parsed: bool) -> String:
 			return (
 				"The NavigationPolygon has no outlines, and a 2D bake fills only the area its "
 				+ "outlines enclose, less what the obstacles inside take. Give it outlines with "
-				+ "scene_node set, such as navigation_polygon/outlines [[[0, 0], [512, 0], [512, 512], "
-				+ "[0, 512]]], then bake again."
+				+ "scene_node set, such as navigation_polygon/outlines [[[0, 0], [512, 0], [512, "
+				+ "512], [0, 512]]], then bake again."
 			)
 		return (
 			(
-				"Nothing was left to walk inside the outlines once the obstacles read from %s, and the "
+				(
+					"Nothing was left to walk inside the outlines once the obstacles read from %s, "
+					+ "and the "
+				)
 				% _source_said(polygon.source_geometry_mode, polygon.source_geometry_group_name)
 			)
 			+ "agent_radius %s kept from their edges, were taken out." % polygon.agent_radius
@@ -225,17 +234,27 @@ static func _why_empty(held: Resource, flat: bool, parsed: bool) -> String:
 	if not parsed:
 		return (
 			(
-				"No geometry was read from %s with geometry_parsed_geometry_type %s, so there was nothing to "
+				(
+					"No geometry was read from %s with geometry_parsed_geometry_type %s, so there "
+					+ "was nothing to "
+				)
 				% [
-					_source_said(mesh.geometry_source_geometry_mode, mesh.geometry_source_group_name),
-					["mesh_instances", "static_colliders", "both"][mesh.geometry_parsed_geometry_type],
+					_source_said(
+						mesh.geometry_source_geometry_mode, mesh.geometry_source_group_name
+					),
+					["mesh_instances", "static_colliders", "both"][
+						mesh.geometry_parsed_geometry_type
+					],
 				]
 			)
-			+ "bake: mesh_instances reads MeshInstance3D nodes, static_colliders the shapes of physics "
-			+ "bodies on geometry_collision_mask, and both reads both."
+			+ "bake: mesh_instances reads MeshInstance3D nodes, static_colliders the shapes of "
+			+ "physics bodies on geometry_collision_mask, and both reads both."
 		)
 	return (
-		"The geometry read gave no floor an agent of agent_height %s and agent_radius %s can stand on."
+		(
+			"The geometry read gave no floor an agent of agent_height %s and agent_radius %s can "
+			+ "stand on."
+		)
 		% [mesh.agent_height, mesh.agent_radius]
 	)
 
@@ -252,7 +271,7 @@ static func _nothing_read(scene: GdhSceneFile, held: Resource) -> String:
 		)
 		% [
 			_source_said(polygon.source_geometry_mode, polygon.source_geometry_group_name),
-			polygon.agent_radius
+			polygon.agent_radius,
 		]
 	)
 	var outside: PackedStringArray = []
@@ -270,8 +289,9 @@ static func _nothing_read(scene: GdhSceneFile, held: Resource) -> String:
 		return said
 	return (
 		(
-			"%s %s %s outside what was read; the bake reads a node elsewhere once it is in the group %s and "
-			+ "source_geometry_mode is groups_with_children, or once it is moved under the region."
+			"%s %s %s outside what was read; the bake reads a node elsewhere once it is in the "
+			+ "group %s and source_geometry_mode is groups_with_children, or once it is moved "
+			+ "under the region."
 		)
 		% [
 			said,

package/build/godot/addons/gdharness_editor/tools/play_tools.gd

@@ -1,6 +1,5 @@
 @tool
 extends Node
-
 ## Running the game from the editor, so the editor is the one debugging it.
 ##
 ## A game started as its own process is a game nothing is attached to: the editor's debug adapter
@@ -10,7 +9,6 @@ extends Node
 
 ## What the display server calls itself when the engine was started with no display at all.
 const GdhRead = preload("../reading.gd")
-
 const HEADLESS_DISPLAY: String = "headless"
 ## Where Godot keeps the port its own debugger listens on for a game it is playing. One setting
 ## for every editor on the machine, and bound only while a game runs.
@@ -18,7 +16,6 @@ const DEBUGGER_SETTING: String = "network/debug/remote_port"
 const LOOPBACK: String = "127.0.0.1"
 
 var _editor_plugin: EditorPlugin = null
-
 ## Which play this is, counted up for every one the editor starts, whoever starts it. What a server
 ## writes about a play is kept on disk after it, and the editor saying it is playing does not say
 ## which play: a server picking a play back up read the console of an earlier one as this one's.
@@ -29,14 +26,14 @@ var _was_playing: bool = false
 var _awaited: bool = false
 
 
-func set_editor_plugin(plugin: EditorPlugin) -> void:
-	_editor_plugin = plugin
-
-
 func _process(_delta: float) -> void:
 	_count_a_play_begun()
 
 
+func set_editor_plugin(plugin: EditorPlugin) -> void:
+	_editor_plugin = plugin
+
+
 ## Counts a play the editor has begun since the last look, whoever began it. Looked at every frame
 ## and before the count is read: read alone, a play begun in this frame went uncounted until this
 ## node's turn came round, and a server asking before then was told the earlier play's number with
@@ -60,20 +57,23 @@ func play_scene(args: Dictionary) -> Dictionary:
 		# play was answered as started.
 		var main: String = str(ProjectSettings.get_setting("application/run/main_scene", ""))
 		if main.is_empty():
-			return {"ok": false, "error": "The project has no main scene to play."}
+			return { "ok": false, "error": "The project has no main scene to play." }
 		if not ResourceLoader.exists(main, "PackedScene"):
 			return {
 				"ok": false,
 				"error":
 				(
-					"The main scene, %s, is not there, so the editor would ask for another rather than play."
+					(
+						"The main scene, %s, is not there, so the editor would ask for another "
+						+ "rather than play."
+					)
 					% main
-				)
+				),
 			}
 	else:
 		full_path = scene_path if scene_path.begins_with("res://") else "res://" + scene_path
 		if not ResourceLoader.exists(full_path, "PackedScene"):
-			return {"ok": false, "error": "No scene at " + full_path}
+			return { "ok": false, "error": "No scene at " + full_path }
 
 	if EditorInterface.is_playing_scene():
 		EditorInterface.stop_playing_scene()
@@ -138,7 +138,7 @@ func stop_playing(_args: Dictionary) -> Dictionary:
 	# Known over now rather than at the next frame's look: a play somebody else starts before that
 	# look would otherwise be read as this one still going, and given its number and its console.
 	_was_playing = EditorInterface.is_playing_scene()
-	return {"ok": true, "wasPlaying": was_playing, "playing": _was_playing}
+	return { "ok": true, "wasPlaying": was_playing, "playing": _was_playing }
 
 
 ## Restarts the editor, which is how a replaced addon is picked up.
@@ -167,7 +167,7 @@ func restart_editor(_args: Dictionary) -> Dictionary:
 				"This editor is headless, and the engine does not hand back the arguments it was "
 				+ "started with, so nothing can bring it back as the editor it is. Start it again "
 				+ "yourself."
-			)
+			),
 		}
 
 	var saving: Dictionary = _save_everything()
@@ -177,7 +177,7 @@ func restart_editor(_args: Dictionary) -> Dictionary:
 	# Deferred so this answer is on its way out before the editor goes.
 	EditorInterface.restart_editor.call_deferred(true)
 
-	return {"ok": true, "restarting": true, "saved": saving["saved"]}
+	return { "ok": true, "restarting": true, "saved": saving["saved"] }
 
 
 ## Saves every open scene, answering a refusal naming what is still unsaved, or the scenes that had
@@ -193,7 +193,7 @@ static func _save_everything() -> Dictionary:
 	EditorInterface.save_all_scenes()
 	var left: PackedStringArray = EditorInterface.get_unsaved_scenes()
 	if left.is_empty():
-		return {"ok": true, "saved": changed}
+		return { "ok": true, "saved": changed }
 	var named: Array[String] = []
 	for scene: String in left:
 		named.append(scene if not scene.is_empty() else "a scene that has never been saved")
@@ -202,15 +202,15 @@ static func _save_everything() -> Dictionary:
 		"error":
 		(
 			(
-				"%s still %s unsaved changes after saving, and ending the editor would lose them. Save "
-				+ "or close %s in the editor first."
+				"%s still %s unsaved changes after saving, and ending the editor would lose them. "
+				+ "Save or close %s in the editor first."
 			)
 			% [
 				", ".join(PackedStringArray(named)),
 				"has" if named.size() == 1 else "have",
-				"it" if named.size() == 1 else "them"
+				"it" if named.size() == 1 else "them",
 			]
-		)
+		),
 	}
 
 
@@ -230,7 +230,7 @@ func quit_editor(_args: Dictionary) -> Dictionary:
 	# Deferred so this answer is on its way out before the editor goes.
 	_leave.call_deferred()
 
-	return {"ok": true, "quitting": true, "saved": saving["saved"]}
+	return { "ok": true, "quitting": true, "saved": saving["saved"] }
 
 
 ## What the editor said as it started each of its servers, and the debug adapter started again when
@@ -258,7 +258,12 @@ func editor_servers(args: Dictionary) -> Dictionary:
 			parent.add_child(adapter)
 			parent.move_child(adapter, at)
 			rebound = true
-	return {"ok": true, "said": said, "rebound": rebound, "saidSince": _servers_said().slice(said.size())}
+	return {
+		"ok": true,
+		"said": said,
+		"rebound": rebound,
+		"saidSince": _servers_said().slice(said.size()),
+	}
 
 
 ## The lines the editor's log panel holds about its language server and debug adapter, in order.

package/build/godot/addons/gdharness_editor/tools/profile_tools.gd

@@ -1,6 +1,5 @@
 @tool
 extends Node
-
 ## The engine's script profiler on a game the editor plays, summed here for the server.
 ##
 ## The editor is that game's debugger, so the profiler is switched on through the editor's own
@@ -11,7 +10,6 @@ extends Node
 ## expose to scripts: found by its class in the editor's tree and connected to by name.
 
 const GdhRead = preload("../reading.gd")
-
 ## The most functions a frame may carry when the server does not say. The engine names a function
 ## once, as it first appears, and the game's debugger queue drops those messages past its size, so
 ## the server keeps this below the queue the project sets; this is that for the engine's default.
@@ -26,37 +24,10 @@ const PROFILE_RECEIVED: String = "gdharness:profile_received"
 ## Kept in step with the runtime addon's runtime_autoload.gd.
 const PROFILE_FROM_START: String = "GDHARNESS_PROFILE_FROM_START"
 
-
-## The editor's debugger sessions, numbered as the editor numbers its debugger tabs.
-class GdhSessions:
-	extends EditorDebuggerPlugin
-
-	signal session_started(session_id: int)
-
-	func _setup_session(session_id: int) -> void:
-		var session: EditorDebuggerSession = get_session(session_id)
-		# int rather than Error: Signal.connect answers with a plain int.
-		var joined: int = session.started.connect(func() -> void: session_started.emit(session_id))
-		if joined != OK:
-			push_error("gdharness could not watch debugger session %d start: %d" % [session_id, joined])
-
-	func _has_capture(capture: String) -> bool:
-		return capture == PROFILE_CAPTURE
-
-	## Answers a quitting game that its profile's totals arrived, which it waits for before it exits.
-	## The editor reads a session's messages in order, so the totals sent before this have been read.
-	func _capture(message: String, _data: Array, session_id: int) -> bool:
-		if message != PROFILE_SENT:
-			return false
-		get_session(session_id).send_message(PROFILE_RECEIVED, [])
-		return true
-
-
 var _editor_plugin: EditorPlugin = null
 var _sessions: GdhSessions = null
 ## The debugger tabs connected to, by instance id, so none is connected twice.
 var _hooked: Dictionary[int, bool] = {}
-
 ## A play asked to be profiled before its session started.
 var _armed: bool = false
 var _session: int = -1
@@ -73,6 +44,12 @@ var _names: Dictionary[int, String] = {}
 var _totals: Dictionary[String, PackedFloat64Array] = {}
 
 
+func _exit_tree() -> void:
+	if _editor_plugin != null and _sessions != null:
+		_editor_plugin.remove_debugger_plugin(_sessions)
+	_sessions = null
+
+
 func set_editor_plugin(plugin: EditorPlugin) -> void:
 	_editor_plugin = plugin
 	_sessions = GdhSessions.new()
@@ -82,12 +59,6 @@ func set_editor_plugin(plugin: EditorPlugin) -> void:
 	plugin.add_debugger_plugin(_sessions)
 
 
-func _exit_tree() -> void:
-	if _editor_plugin != null and _sessions != null:
-		_editor_plugin.remove_debugger_plugin(_sessions)
-	_sessions = null
-
-
 ## Switches the profiler on for the game being played, or with [code]arm[/code] for the next one
 ## to start and never the one playing: a start ends the game before it, which can still be going.
 ## Either way what was summed before is dropped.
@@ -98,8 +69,9 @@ func profile_start(args: Dictionary) -> Dictionary:
 			"error":
 			(
 				(
-					"This editor's debugger has no %s node to read the profiler from, which is where Godot"
-					+ " 4.7 keeps it: a Godot that moved it has to be met by a gdharness that knows where."
+					"This editor's debugger has no %s node to read the profiler from, which is "
+					+ "where Godot 4.7 keeps it: a Godot that moved it has to be met by a "
+					+ "gdharness that knows where."
 				)
 				% DEBUGGER_CLASS
 			),
@@ -113,12 +85,12 @@ func profile_start(args: Dictionary) -> Dictionary:
 		# runtime addon to hold its start until the profiler is on, which the session's start
 		# switches on with a message the game reads only on a later poll.
 		OS.set_environment(PROFILE_FROM_START, "1")
-		return {"ok": true, "started": false, "armed": true, "session": -1}
+		return { "ok": true, "started": false, "armed": true, "session": -1 }
 	var active: int = _active_session()
 	if active < 0:
-		return {"ok": true, "started": false, "armed": false, "session": -1}
+		return { "ok": true, "started": false, "armed": false, "session": -1 }
 	_switch_on(active)
-	return {"ok": true, "started": true, "armed": false, "session": active}
+	return { "ok": true, "started": true, "armed": false, "session": active }
 
 
 ## What has been summed, for the server to put into an answer.
@@ -256,3 +228,31 @@ func _add(data: Array, into: Dictionary[String, PackedFloat64Array]) -> int:
 		into[signature] = sum
 		carried += 1
 	return carried
+
+
+## The editor's debugger sessions, numbered as the editor numbers its debugger tabs.
+class GdhSessions:
+	extends EditorDebuggerPlugin
+
+	signal session_started(session_id: int)
+
+	func _setup_session(session_id: int) -> void:
+		var session: EditorDebuggerSession = get_session(session_id)
+		# int rather than Error: Signal.connect answers with a plain int.
+		var joined: int = session.started.connect(func() -> void: session_started.emit(session_id))
+		if joined != OK:
+			push_error(
+				"gdharness could not watch debugger session %d start: %d" % [session_id, joined]
+			)
+
+	func _has_capture(capture: String) -> bool:
+		return capture == PROFILE_CAPTURE
+
+	## Answers a quitting game that its profile's totals arrived, which it waits for before it
+	## exits. The editor reads a session's messages in order, so the totals sent before this have
+	## been read.
+	func _capture(message: String, _data: Array, session_id: int) -> bool:
+		if message != PROFILE_SENT:
+			return false
+		get_session(session_id).send_message(PROFILE_RECEIVED, [])
+		return true