gdharness 1.3.0 → 1.3.2

package/build/godot/addons/gdharness_editor/property_values.gd

@@ -14,8 +14,10 @@ extends RefCounted
 ## write accepts. What is here on top of it is the part only a property knows: the type wanted, so a
 ## dictionary shaped like a vector or a bare pair of numbers can be read as one.
 
-const Read = preload("reading.gd")
-const Serialisation = preload("serialisation.gd")
+const GdhDeclared = preload("declared_values.gd")
+const GdhRead = preload("reading.gd")
+const GdhSerialisation = preload("serialisation.gd")
+const GdhShapes = preload("value_shapes.gd")
 
 # The data types a Theme names its items by, as in "Button/colors/font_color", and what each holds.
 const THEME_ITEMS: Dictionary[String, Array] = {
@@ -65,12 +67,23 @@ const FLOAT_SHAPES: Array[int] = [
 # names, so a write to "Visibility" or "Transform" changed nothing and was answered as made.
 const HEADINGS: int = PROPERTY_USAGE_CATEGORY | PROPERTY_USAGE_GROUP | PROPERTY_USAGE_SUBGROUP
 
-var _values: Serialisation = Serialisation.new()
+var _values: GdhSerialisation = GdhSerialisation.new()
 
 # Why the value being parsed cannot be written, when the parse is what found out. A resource is
 # built inside the parse and there is nowhere in a parsed value to put the reason it is wrong.
 var _refused: String = ""
 
+# The stored properties the last write_all changed without being given them, by name, as [what it
+# held before, what it holds now]. A setter keeps other properties in step with the one it is given:
+# a Gradient given a third colour gives that point an offset of 0, a Control given a size moves its
+# offsets. An answer naming only what was given leaves the caller to guess the rest.
+var _also_changed: Dictionary = {}
+
+# The values the last write_all wrote outside what their property declares, by name, as a sentence
+# saying so: a number past an export range, or one no enum value has. The engine stores either, and
+# the inspector would not have let it be entered, so a write answered as made said nothing of it.
+var _outside_declared: Dictionary = {}
+
 
 ## Turns what arrived over the wire into the Godot value a property wants.
 ##
@@ -85,7 +98,7 @@ func parse(value: Variant, expected_type: int = TYPE_NIL, elements: Array = [])
 		var fields: Dictionary = value
 		# A dictionary with keys that are not text arrives as its entries, and is read against the
 		# declared element types like any other.
-		if str(fields.get("_type", "")) == "Dictionary" and Serialisation.pairs(fields.get("entries")):
+		if str(fields.get("_type", "")) == "Dictionary" and GdhSerialisation.pairs(fields.get("entries")):
 			var built: Dictionary = _values.deserialize_value(fields)
 			return _parse_entries(built, elements)
 		var tagged: Array = _parse_tagged_dictionary(fields)
@@ -113,38 +126,39 @@ func cannot_hold(
 ) -> String:
 	var held: String = type_string(expected_type)
 	var cost: String = " Setting it would save a different value than the one asked for."
-	if not Serialisation.acceptable(value, expected_type):
+	if not GdhSerialisation.acceptable(value, expected_type):
 		var shape: String = "%s.%s is %s and the value given is %s, which cannot become one."
-		return shape % [holder, property, held, type_string(typeof(value))] + cost
+		var remedy: String = GdhShapes.remedy(value, expected_type)
+		return shape % [holder, property, held, type_string(typeof(value))] + remedy + cost
 
 	# And the same question of each element, because a list is accepted for a packed or typed array
 	# whatever is in it: a polygon written as [{"x": 1}] passes the check above and lands as one zero
 	# vector, and [1.5, "x"] for a PackedInt32Array as [1, 0].
-	var element: int = Read.as_int(PACKED_ELEMENTS.get(expected_type, TYPE_NIL), TYPE_NIL)
+	var element: int = GdhRead.as_int(PACKED_ELEMENTS.get(expected_type, TYPE_NIL), TYPE_NIL)
 	if expected_type == TYPE_ARRAY and not elements.is_empty():
-		element = Read.as_int(elements[0], TYPE_NIL)
+		element = GdhRead.as_int(elements[0], TYPE_NIL)
 	if element != TYPE_NIL and value is Array:
 		var items: Array = value
 		for index: int in items.size():
-			if not Serialisation.acceptable(items[index], element):
+			if not GdhSerialisation.acceptable(items[index], element):
 				var shape: String = "%s.%s is %s and item %d of the list given is %s, not %s."
 				var named: Array = [
 					holder, property, held, index, type_string(typeof(items[index])), type_string(element)
 				]
-				return shape % named + cost
+				return shape % named + GdhShapes.remedy(items[index], element) + cost
 	if expected_type == TYPE_DICTIONARY and elements.size() == 2 and value is Dictionary:
 		var entries: Dictionary = value
-		var key_type: int = Read.as_int(elements[0], TYPE_NIL)
-		var value_type: int = Read.as_int(elements[1], TYPE_NIL)
+		var key_type: int = GdhRead.as_int(elements[0], TYPE_NIL)
+		var value_type: int = GdhRead.as_int(elements[1], TYPE_NIL)
 		for key: Variant in entries:
-			if not Serialisation.acceptable(key, key_type):
+			if not GdhSerialisation.acceptable(key, key_type):
 				var shape: String = "%s.%s has %s keys, and %s is not one."
 				return shape % [holder, property, type_string(key_type), shown(key)] + cost
 			var entry: Variant = entries[key]
-			if not Serialisation.acceptable(entry, value_type):
+			if not GdhSerialisation.acceptable(entry, value_type):
 				var shape: String = "%s.%s holds %s values, and the one given for %s is %s."
 				var named: Array = [holder, property, type_string(value_type), shown(key), shown(entry)]
-				return shape % named + cost
+				return shape % named + GdhShapes.remedy(entry, value_type) + cost
 	return ""
 
 
@@ -168,19 +182,35 @@ func cannot_hold(
 ## Nothing here saves, so a refusal partway leaves the change in memory and the file as it was. The
 ## caller returns the refusal instead of saving.
 func write_all(target: Object, properties: Dictionary) -> String:
+	_also_changed = {}
+	_outside_declared = {}
+	var named: Dictionary = {}
+	for key: Variant in properties:
+		named[str(key).get_slice(":", 0)] = true
+	var before: Dictionary = _stored(target, named)
 	var given: Dictionary = {}
+	# A refusal of one of several leaves the others unwritten too, which a refusal naming only the
+	# one it refused left a caller to guess.
+	var unwritten: String = (
+		"" if properties.size() < 2 else " None of the %d properties given was written." % properties.size()
+	)
 	for key: Variant in properties:
 		var property: String = str(key)
 		var declared: Dictionary = declaration(target, property)
 		if declared.is_empty() and ":" in property:
 			declared = _component_slot(target, property)
 			if declared.has("refused"):
-				return str(declared["refused"])
+				return str(declared["refused"]) + unwritten
+		if declared.is_empty() and target is ShaderMaterial and property.begins_with("shader_parameter/"):
+			return _no_uniform(target as ShaderMaterial, property) + unwritten
 		if declared.is_empty():
-			return "%s has no property %s" % [target.get_class(), property]
+			return "%s has no property %s." % [class_called(target), property] + unwritten
 		var value: Array = value_for(target, declared, properties[key])
 		if not value[0]:
-			return str(value[1])
+			return str(value[1]) + unwritten
+		var outside: String = GdhDeclared.outside(target, declared, value[1], shown(value[1]))
+		if not outside.is_empty():
+			_outside_declared[property] = outside
 		_write(target, property, value[1])
 		given[property] = value[1]
 
@@ -197,9 +227,83 @@ func write_all(target: Object, properties: Dictionary) -> String:
 				)
 				% [target.get_class(), property, shown(given[property]), shown(held)]
 			)
+	for property: String in before:
+		var now: Variant = target.get(property)
+		if not same(now, before[property]):
+			_also_changed[property] = [before[property], now]
 	return ""
 
 
+## Why [param material] has no [param property]: a ShaderMaterial's parameters are its shader's
+## uniforms, so the shader is what lacks one, and "ShaderMaterial has no property" named the
+## material.
+static func _no_uniform(material: ShaderMaterial, property: String) -> String:
+	var uniform: String = property.trim_prefix("shader_parameter/")
+	if material.shader == null:
+		return "The ShaderMaterial has no shader, so it has no parameter %s yet; set shader first." % uniform
+	var shader: String = material.shader.resource_path
+	var named: String = shader if not shader.is_empty() else "Its shader"
+	var uniforms: Array = []
+	for entry: Dictionary in material.shader.get_shader_uniform_list():
+		uniforms.append(str(entry["name"]))
+	var said: String = "%s declares no uniform %s, which %s would set" % [named, uniform, property]
+	if uniforms.is_empty():
+		return said + "; it declares no uniforms."
+	return GdhRead.offered(said, uniform, uniforms) + "."
+
+
+## Puts under alsoChanged in [param answer] each property the last [method write_all] changed
+## without being given it, as {was, now}, and under outsideDeclared each value it wrote outside what
+## its property declares, when there are any. A node is named by its path from [param relative_to],
+## as a scene answer names one. Called before the scene is written, since the write frees the nodes
+## these values can hold.
+func note_write(answer: Dictionary, relative_to: Node = null) -> void:
+	if not _outside_declared.is_empty():
+		answer["outsideDeclared"] = _outside_declared.duplicate()
+	if _also_changed.is_empty():
+		return
+	var noted: Dictionary = {}
+	for property: Variant in _also_changed:
+		var pair: Array = _also_changed[property]
+		noted[property] = {"was": _readable(pair[0], relative_to), "now": _readable(pair[1], relative_to)}
+	answer["alsoChanged"] = noted
+
+
+func _readable(value: Variant, relative_to: Node) -> Variant:
+	if value is Node and relative_to != null:
+		var target: Node = value
+		return _values.serialize_value(relative_to.get_path_to(target))
+	if value is Array:
+		var items: Array = value
+		return items.map(func(item: Variant) -> Variant: return _readable(item, relative_to))
+	return _values.serialize_value(value)
+
+
+## What [param target] stores, by name, but its script and the properties in [param leave]. A list
+## or a map is copied, since a setter can change the one it holds in place.
+func _stored(target: Object, leave: Dictionary) -> Dictionary:
+	var held: Dictionary = {}
+	for entry: Dictionary in target.get_property_list():
+		var name: String = str(entry["name"])
+		var usage: int = GdhRead.as_int(entry["usage"])
+		if (
+			usage & PROPERTY_USAGE_STORAGE == 0
+			or usage & HEADINGS != 0
+			or name == "script"
+			or leave.has(name)
+		):
+			continue
+		var value: Variant = target.get(name)
+		if value is Array:
+			var listed: Array = value
+			value = listed.duplicate(true)
+		elif value is Dictionary:
+			var mapped: Dictionary = value
+			value = mapped.duplicate(true)
+		held[name] = value
+	return held
+
+
 ## What [param target] holds under [param key], a property or a colon path into one's components.
 func read_at(target: Object, key: String) -> Variant:
 	if ":" in key and declaration(target, key).is_empty():
@@ -228,9 +332,8 @@ func _component_slot(target: Object, path: String) -> Dictionary:
 	var walked: String = steps[0]
 	for index: int in range(1, steps.size()):
 		var step: String = steps[index]
-		var has: PackedStringArray = Serialisation.components_of(value)
-		var kind: String = type_string(typeof(value))
-		var sort: String = ("an " if kind.left(1).to_upper() in ["A", "E", "I", "O", "U"] else "a ") + kind
+		var has: PackedStringArray = GdhSerialisation.components_of(value)
+		var sort: String = GdhRead.with_article(type_string(typeof(value)))
 		if has.is_empty():
 			return {
 				"refused":
@@ -255,10 +358,22 @@ func _component_slot(target: Object, path: String) -> Dictionary:
 ## [param raw] as the value [param declared] takes, as [ok, value] or [false, why not].
 func value_for(target: Object, declared: Dictionary, raw: Variant) -> Array:
 	var property: String = str(declared.get("name", ""))
-	var expected_type: int = Read.as_int(declared.get("type", TYPE_NIL), TYPE_NIL)
-	var hint: int = Read.as_int(declared.get("hint", PROPERTY_HINT_NONE))
+	var expected_type: int = GdhRead.as_int(declared.get("type", TYPE_NIL), TYPE_NIL)
+	var hint: int = GdhRead.as_int(declared.get("hint", PROPERTY_HINT_NONE))
 	if expected_type == TYPE_OBJECT and hint == PROPERTY_HINT_NODE_TYPE:
 		return _node_reference(target, property, raw)
+	# An enum is written by the name of a value as well as its number, since the name is what the
+	# script and the inspector show and the number is only where the value happens to sit.
+	if expected_type == TYPE_INT and hint == PROPERTY_HINT_ENUM and typeof(raw) == TYPE_STRING:
+		var choices: Dictionary = GdhDeclared.enum_of(target, declared)
+		var chosen: Variant = GdhDeclared.enum_named(choices, str(raw))
+		if chosen == null:
+			var hinted: Dictionary = GdhDeclared.enum_values(str(declared.get("hint_string", "")))
+			chosen = GdhDeclared.enum_named(hinted, str(raw))
+		if chosen != null:
+			return [true, chosen]
+		if not str(raw).strip_edges().is_valid_int():
+			return [false, GdhDeclared.enum_refusal(class_called(target), property, str(raw), choices)]
 
 	# A resource-valued property takes the path of one, which is how a caller names a TileSet,
 	# a material or a theme: there is no other way to hand a tool a Resource.
@@ -272,14 +387,14 @@ func value_for(target: Object, declared: Dictionary, raw: Variant) -> Array:
 		var elements: Array = elements_of(declared)
 		if _fraction(raw, expected_type, elements):
 			return [false, _fraction_refusal(target, property, raw)]
-		var rounded: String = Serialisation.inexact(raw, expected_type)
+		var rounded: String = GdhSerialisation.inexact(raw, expected_type)
 		if not rounded.is_empty():
-			return [false, "%s.%s holds int: %s." % [target.get_class(), property, rounded]]
+			return [false, "%s.%s holds int: %s." % [class_called(target), property, rounded]]
 		_refused = ""
 		value = parse(raw, expected_type, elements)
 		if not _refused.is_empty():
 			return [false, _refused]
-		var refusal: String = cannot_hold(target.get_class(), property, value, expected_type, elements)
+		var refusal: String = cannot_hold(class_called(target), property, value, expected_type, elements)
 		if not refusal.is_empty():
 			return [false, refusal]
 	if value is Object:
@@ -328,7 +443,7 @@ func _node_reference(target: Object, property: String, raw: Variant) -> Array:
 ## an object of the wrong class: measured on 4.7.2, a Sprite2D given a Material for its texture
 ## held nothing afterwards, and the scene was saved without the texture it had.
 func _wrong_class(value: Object, declared: Dictionary) -> String:
-	var hint: int = Read.as_int(declared.get("hint", PROPERTY_HINT_NONE))
+	var hint: int = GdhRead.as_int(declared.get("hint", PROPERTY_HINT_NONE))
 	var wanted: String = str(declared.get("hint_string", ""))
 	if hint != PROPERTY_HINT_RESOURCE_TYPE or wanted.is_empty():
 		return ""
@@ -354,8 +469,8 @@ func _wrong_class(value: Object, declared: Dictionary) -> String:
 ## behind a placeholder in the editor, and measured on 4.7.2 that placeholder stores [1.5, 2.0]
 ## as given, which the game then fails to load into the typed array.
 static func elements_of(declared: Dictionary) -> Array:
-	var type: int = Read.as_int(declared.get("type", TYPE_NIL), TYPE_NIL)
-	var hint: int = Read.as_int(declared.get("hint", PROPERTY_HINT_NONE))
+	var type: int = GdhRead.as_int(declared.get("type", TYPE_NIL), TYPE_NIL)
+	var hint: int = GdhRead.as_int(declared.get("hint", PROPERTY_HINT_NONE))
 	var wanted: String = str(declared.get("hint_string", ""))
 	if wanted.is_empty():
 		return []
@@ -397,21 +512,21 @@ func _fraction(value: Variant, type: int, elements: Array = []) -> bool:
 	if type == TYPE_INT:
 		var number: Variant = value
 		if typeof(value) == TYPE_STRING:
-			number = Read.json_or_null(str(value))
+			number = GdhRead.json_or_null(str(value))
 		if typeof(number) != TYPE_FLOAT:
 			return false
 		var whole: float = number
 		return is_finite(whole) and whole != floorf(whole)
-	var element: int = Read.as_int(PACKED_ELEMENTS.get(type, TYPE_NIL), TYPE_NIL)
+	var element: int = GdhRead.as_int(PACKED_ELEMENTS.get(type, TYPE_NIL), TYPE_NIL)
 	if type == TYPE_ARRAY and not elements.is_empty():
-		element = Read.as_int(elements[0], TYPE_NIL)
+		element = GdhRead.as_int(elements[0], TYPE_NIL)
 	if value is Array and element != TYPE_NIL:
 		var items: Array = value
 		return items.any(func(item: Variant) -> bool: return _fraction(item, element))
 	if type == TYPE_DICTIONARY and elements.size() == 2 and value is Dictionary:
 		var entries: Dictionary = value
-		var key_type: int = Read.as_int(elements[0], TYPE_NIL)
-		var value_type: int = Read.as_int(elements[1], TYPE_NIL)
+		var key_type: int = GdhRead.as_int(elements[0], TYPE_NIL)
+		var value_type: int = GdhRead.as_int(elements[1], TYPE_NIL)
 		for key: Variant in entries:
 			if _fraction(key, key_type) or _fraction(entries[key], value_type):
 				return true
@@ -424,10 +539,43 @@ func _fraction_refusal(target: Object, property: String, raw: Variant) -> String
 			"%s.%s holds whole numbers, and %s would be cut to fit. Setting it would save a different "
 			+ "value than the one asked for."
 		)
-		% [target.get_class(), property, shown(raw)]
+		% [class_called(target), property, shown(raw)]
 	)
 
 
+## [param raw] as a colour, read as a property write reads one, as [true, Color] or [false, why]:
+## fields from 0 to 1 with a optional, or an html code. [param named] is what the refusal calls it.
+func colour_from(raw: Variant, named: String) -> Array:
+	_refused = ""
+	var value: Variant = parse(raw, TYPE_COLOR)
+	if not _refused.is_empty():
+		return [false, _refused]
+	if value is Color:
+		return [true, value]
+	return [
+		false,
+		(
+			(
+				'%s is {"r": .., "g": .., "b": .., "a": ..} from 0 to 1, a optional, or an html code such as '
+				+ '"#ff8000" or "#ff800080"; %s is neither.'
+			)
+			% [named, JSON.stringify(raw)]
+		)
+	]
+
+
+## What [param target] is called in a refusal: the class_name its script declares, or else its
+## engine class. A resource made as a project class is a Resource to the engine, and "Resource.kind"
+## named a property no Resource has.
+static func class_called(target: Object) -> String:
+	var attached: Variant = target.get_script()
+	if attached is Script:
+		var script: Script = attached
+		if not str(script.get_global_name()).is_empty():
+			return str(script.get_global_name())
+	return target.get_class()
+
+
 ## The resource [param path] names, as [found, resource or why not].
 ##
 ## The project boundary is enforced here as well as on the server, because only the engine knows
@@ -451,6 +599,19 @@ func _resource_at(path: String, property: String) -> Array:
 			)
 		]
 	if not ResourceLoader.exists(path):
+		# An image or a sound nobody has imported is a file the engine has no loader for, and "No
+		# resource at" sent a caller looking for a file that was there.
+		if path.begins_with("res://") and FileAccess.file_exists(path):
+			return [
+				false,
+				(
+					(
+						"%s is there, but it has never been imported, so the engine has no resource to load"
+						+ " from it for %s. project_import reimport with resourcePath %s imports it."
+					)
+					% [path, property, path]
+				)
+			]
 		return [false, "No resource at %s for %s" % [path, property]]
 	return [true, load(path)]
 
@@ -463,7 +624,7 @@ func declaration(target: Object, property: String) -> Dictionary:
 	for declared: Dictionary in target.get_property_list():
 		if str(declared.get("name", "")) != property:
 			continue
-		if Read.as_int(declared.get("usage", 0)) & HEADINGS:
+		if GdhRead.as_int(declared.get("usage", 0)) & HEADINGS:
 			continue
 		return declared
 	if target is Theme:
@@ -503,13 +664,13 @@ static func same(held: Variant, given: Variant) -> bool:
 		return held_none == given_none
 	if held_type == TYPE_OBJECT or given_type == TYPE_OBJECT:
 		return _same_object(held, given)
-	if Serialisation.NUMBERS.has(held_type) and Serialisation.NUMBERS.has(given_type):
+	if GdhSerialisation.NUMBERS.has(held_type) and GdhSerialisation.NUMBERS.has(given_type):
 		if held_type == TYPE_BOOL or given_type == TYPE_BOOL:
 			return held_type == given_type and held == given
-		var held_number: float = Read.as_float(held)
-		var given_number: float = Read.as_float(given)
+		var held_number: float = GdhRead.as_float(held)
+		var given_number: float = GdhRead.as_float(given)
 		return (is_nan(held_number) and is_nan(given_number)) or is_equal_approx(held_number, given_number)
-	if Serialisation.TEXTS.has(held_type) and Serialisation.TEXTS.has(given_type):
+	if GdhSerialisation.TEXTS.has(held_type) and GdhSerialisation.TEXTS.has(given_type):
 		return str(held) == str(given)
 	if _listed(held_type) and _listed(given_type):
 		var held_items: Array = type_convert(held, TYPE_ARRAY)
@@ -675,7 +836,7 @@ func _parse_shaped_dictionary(value: Dictionary, expected_type: int, elements: A
 	if expected_type == TYPE_NIL or expected_type == TYPE_DICTIONARY:
 		return _parse_entries(value, elements)
 	var tag: String = type_string(expected_type)
-	if Serialisation.REQUIRED.has(tag):
+	if GdhShapes.REQUIRED.has(tag):
 		var tagged: Dictionary = value.duplicate()
 		tagged["_type"] = tag
 		var built: Variant = _values.deserialize_value(tagged)
@@ -690,8 +851,8 @@ func _parse_entries(value: Dictionary, elements: Array) -> Dictionary:
 	var key_type: int = TYPE_NIL
 	var value_type: int = TYPE_NIL
 	if elements.size() == 2:
-		key_type = Read.as_int(elements[0], TYPE_NIL)
-		value_type = Read.as_int(elements[1], TYPE_NIL)
+		key_type = GdhRead.as_int(elements[0], TYPE_NIL)
+		value_type = GdhRead.as_int(elements[1], TYPE_NIL)
 	var entries: Dictionary = {}
 	for key: Variant in value:
 		entries[_values.fitted(key, key_type)] = parse(value[key], value_type)
@@ -709,7 +870,7 @@ func _typed_dictionary(entries: Dictionary, key_type: int, value_type: int) -> D
 	for key: Variant in entries:
 		if key_type != TYPE_NIL and typeof(key) != key_type:
 			return entries
-		if not Serialisation.acceptable(entries[key], value_type):
+		if not GdhSerialisation.acceptable(entries[key], value_type):
 			return entries
 	var fitted: Dictionary = {}
 	for key: Variant in entries:
@@ -720,46 +881,48 @@ func _typed_dictionary(entries: Dictionary, key_type: int, value_type: int) -> D
 ## An array, either positional for a vector the property declares, or a list to parse per item.
 func _parse_array(value: Array, expected_type: int, elements: Array) -> Variant:
 	if PACKED_ELEMENTS.has(expected_type):
-		var element: int = Read.as_int(PACKED_ELEMENTS[expected_type], TYPE_NIL)
+		var element: int = GdhRead.as_int(PACKED_ELEMENTS[expected_type], TYPE_NIL)
 		return value.map(func(item: Variant) -> Variant: return parse(item, element))
 
 	match expected_type:
 		TYPE_VECTOR2:
 			if value.size() == 2:
-				return Vector2(Read.as_float(value[0]), Read.as_float(value[1]))
+				return Vector2(GdhRead.as_float(value[0]), GdhRead.as_float(value[1]))
 		TYPE_VECTOR2I:
 			if value.size() == 2:
-				return Vector2i(Read.as_int(value[0]), Read.as_int(value[1]))
+				return Vector2i(GdhRead.as_int(value[0]), GdhRead.as_int(value[1]))
 		TYPE_VECTOR3:
 			if value.size() == 3:
-				return Vector3(Read.as_float(value[0]), Read.as_float(value[1]), Read.as_float(value[2]))
+				return Vector3(
+					GdhRead.as_float(value[0]), GdhRead.as_float(value[1]), GdhRead.as_float(value[2])
+				)
 		TYPE_VECTOR3I:
 			if value.size() == 3:
-				return Vector3i(Read.as_int(value[0]), Read.as_int(value[1]), Read.as_int(value[2]))
+				return Vector3i(GdhRead.as_int(value[0]), GdhRead.as_int(value[1]), GdhRead.as_int(value[2]))
 		TYPE_VECTOR4:
 			if value.size() == 4:
 				return Vector4(
-					Read.as_float(value[0]),
-					Read.as_float(value[1]),
-					Read.as_float(value[2]),
-					Read.as_float(value[3])
+					GdhRead.as_float(value[0]),
+					GdhRead.as_float(value[1]),
+					GdhRead.as_float(value[2]),
+					GdhRead.as_float(value[3])
 				)
 		TYPE_COLOR:
 			if value.size() == 3 or value.size() == 4:
 				return Color(
-					Read.as_float(value[0]),
-					Read.as_float(value[1]),
-					Read.as_float(value[2]),
-					Read.as_float(value[3]) if value.size() == 4 else 1.0
+					GdhRead.as_float(value[0]),
+					GdhRead.as_float(value[1]),
+					GdhRead.as_float(value[2]),
+					GdhRead.as_float(value[3]) if value.size() == 4 else 1.0
 				)
 
 	var element_type: int = TYPE_NIL
 	if expected_type == TYPE_ARRAY and not elements.is_empty():
-		element_type = Read.as_int(elements[0], TYPE_NIL)
+		element_type = GdhRead.as_int(elements[0], TYPE_NIL)
 	var items: Array = value.map(func(item: Variant) -> Variant: return parse(item, element_type))
 	if element_type == TYPE_NIL or element_type == TYPE_OBJECT:
 		return items
-	if not items.all(func(item: Variant) -> bool: return Serialisation.acceptable(item, element_type)):
+	if not items.all(func(item: Variant) -> bool: return GdhSerialisation.acceptable(item, element_type)):
 		return items
 	var fitted: Array = items.map(func(item: Variant) -> Variant: return type_convert(item, element_type))
 	return Array(fitted, element_type, &"", null)

package/build/godot/addons/gdharness_editor/reading.gd

@@ -139,3 +139,68 @@ static func missing_below(
 			"its children are " + shown if not children.is_empty() else "it has no children",
 		]
 	)
+
+
+## [param said], the refusal for a [param kind] the scene does not have at [param node_path], with
+## what is there when the scene has a node there, [param found] its class, and [param holders], the
+## paths of the nodes in the scene that are one, so the caller has the path to pass. Names up to
+## [constant NAMED_CHILDREN] of them.
+static func not_of_kind(
+	said: String, node_path: String, found: String, kind: String, holders: PackedStringArray
+) -> String:
+	var told: String = said + ("" if said.ends_with(".") else ".")
+	if not found.is_empty():
+		told += ' The node at "%s" is %s, not %s.' % [node_path, with_article(found), with_article(kind)]
+	if holders.is_empty():
+		return told + " The scene holds no %s." % kind
+	var quoted: PackedStringArray = []
+	for holder: String in holders.slice(0, NAMED_CHILDREN):
+		var _quoted: bool = quoted.append('"%s"' % holder)
+	var shown: String = ", ".join(quoted)
+	if holders.size() > NAMED_CHILDREN:
+		shown += " and %d more" % (holders.size() - NAMED_CHILDREN)
+	if holders.size() == 1:
+		return told + " The scene's %s is at %s." % [kind, shown]
+	return told + " The scene's %ss are at %s." % [kind, shown]
+
+
+## Up to three of [param names] closest to [param word], closest first, ignoring case: the names a
+## refusal offers for one that is not there, as a typo usually is one of them.
+static func nearest(word: String, names: PackedStringArray) -> PackedStringArray:
+	var wanted: String = word.to_lower()
+	var close: Array[String] = []
+	for name: String in names:
+		if name.to_lower().similarity(wanted) >= 0.5:
+			close.append(name)
+	close.sort_custom(
+		func(a: String, b: String) -> bool:
+			return a.to_lower().similarity(wanted) > b.to_lower().similarity(wanted)
+	)
+	return PackedStringArray(close.slice(0, 3))
+
+
+## [param said], the refusal for [param word], which is not among [param names], with those nearest
+## it when any are, or else every one of them, so the caller has a name to send instead.
+static func offered(said: String, word: String, names: Array) -> String:
+	var every: PackedStringArray = PackedStringArray(names)
+	var close: PackedStringArray = nearest(word, every)
+	if close.is_empty():
+		return "%s; it has %s" % [said, ", ".join(every)]
+	return "%s; the nearest it has %s %s" % [said, "is" if close.size() == 1 else "are", ", ".join(close)]
+
+
+## The signals [param object] has that a caller can connect, its own class's first: the engine
+## lists them from Object down, which puts a Button's pressed after thirty a Control has, and names
+## starting with an underscore are the engine's own.
+static func signals_of(object: Object) -> Array:
+	var names: Array = []
+	for entry: Dictionary in object.get_signal_list():
+		var name: String = str(entry["name"])
+		if not name.begins_with("_"):
+			names.push_front(name)
+	return names
+
+
+## [param word] after the article it takes, "an AnimationTree" or "a Node2D".
+static func with_article(word: String) -> String:
+	return ("an " if word.left(1).to_upper() in ["A", "E", "I", "O", "U"] else "a ") + word