Merge pull request #135 from endlessm/T35540-rich-text-tooltips

Add rich-text tooltips for blocks

Author: manuq

addons/block_code/ui/blocks/block/block.gd

@@ -78,3 +78,9 @@ func serialize_props(prop_names: Array) -> Array:
 	for p in prop_names:
 		pairs.append([p, self.get(p)])
 	return pairs
+
+
+func _make_custom_tooltip(for_text) -> Control:
+	var tooltip = preload("res://addons/block_code/ui/tooltip/tooltip.tscn").instantiate()
+	tooltip.text = for_text
+	return tooltip

addons/block_code/ui/picker/categories/category_factory.gd

@@ -206,12 +206,21 @@ static func get_general_blocks() -> Array[Block]:
 	b.block_formats = ["repeat {number: INT}"]
 	b.statements = ["for __i in {number}:"]
 	b.category = "Loops"
+	b.tooltip_text = "Run the connected blocks [i]number[/i] times"
 	block_list.append(b)
 
 	b = BLOCKS["control_block"].instantiate()
 	b.block_formats = ["while {condition: BOOL}"]
 	b.statements = ["while {condition}:"]
 	b.category = "Loops"
+	b.tooltip_text = (
+		"""
+	Run the connected blocks as long as [i]condition[/i] is true.
+
+	Hint: snap a [b]Comparison[/b] block into the condition.
+	"""
+		. dedent()
+	)
 	block_list.append(b)
 
 	b = BLOCKS["statement_block"].instantiate()

addons/block_code/ui/tooltip/tooltip.gd

@@ -0,0 +1,24 @@
+@tool
+class_name Tooltip
+extends RichTextLabel
+## Rich-text control for block tooltips that matches the built-in inspector's tooltips' font styles
+
+
+func override_font(font_name: StringName, editor_font_name: StringName) -> Font:
+	var font = get_theme_font(editor_font_name, &"EditorFonts")
+	add_theme_font_override(font_name, font)
+	return font
+
+
+func _ready():
+	# Set fonts to match documentation tooltips in inspector
+	override_font(&"normal_font", &"doc")
+	override_font(&"mono_font", &"doc_source")
+	override_font(&"bold_font", &"doc_bold")
+	var italics = override_font(&"italics_font", &"doc_italic")
+
+	# No doc_ style for bold italic; fake it by emboldening the italic style
+	var bold_italics = FontVariation.new()
+	bold_italics.set_base_font(italics)
+	bold_italics.set_variation_embolden(1.2)
+	add_theme_font_override(&"bold_italics_font", bold_italics)

addons/block_code/ui/tooltip/tooltip.tscn

@@ -0,0 +1,14 @@
+[gd_scene load_steps=2 format=3 uid="uid://bmxco03vqyq2t"]
+
+[ext_resource type="Script" path="res://addons/block_code/ui/tooltip/tooltip.gd" id="1_4ko6a"]
+
+[node name="Tooltip" type="RichTextLabel"]
+custom_minimum_size = Vector2(360, 48)
+anchors_preset = 15
+anchor_right = 1.0
+anchor_bottom = 1.0
+grow_horizontal = 2
+grow_vertical = 2
+bbcode_enabled = true
+fit_content = true
+script = ExtResource("1_4ko6a")