Initial

Author: NancokPS2

classes/Tooltip.gd

@@ -15,15 +15,21 @@ const INVISIBLE_RECT: Rect2 = Rect2()
 signal visibility_update_required
 
 @export_category("Settings")
-@export var allow_sub_tooltips: bool = true
-@export var pin_action: String = "ui_accept"
+# TODO: when we update to 4.3.1, i'll add proper sub-tooltip support. The current approach works like ass. So in the meantime this will remain off by default
+@export var allow_sub_tooltips: bool = false
+@export var pin_action: String = "j_pin_tooltip":
+	set(val):
+		pin_action = val
+		#Disable input if the pin_action is ""
+		set_process_input(not pin_action == "")
 
 @export_category("Appereance")
+## Will cause the tooltip to automatically choose a direction, ignores the popup_dir property while active.
 @export var auto_choose_direction: bool = true
 
 @export var popup_dir: PopupDirections = PopupDirections.UP
 
-@export var text: String = "Placeholder":
+@export_multiline var text: String = "Placeholder":
 	set(value):
 		if label:
 			text = value
@@ -46,7 +52,6 @@ var pinned: bool = false:
 		pinned = val
 		visibility_update_required.emit()
 
-#var keyword_rect_dict: Dictionary
 var panel := Panel.new()
 var label := RichTextLabel.new()
 
@@ -89,7 +94,7 @@ func _ready() -> void:
 		update_input_processing()
 		return
 
-	sub_tooltip = add_to_control(label, true)
+	sub_tooltip = Tooltip.add_to_control(label, true)
 
 	pinned = pinned
 	connect_target_signals(get_target())
@@ -115,6 +120,34 @@ func get_target() -> Control:
 	return get_parent() if get_parent() is Control else null
 
 
+func get_distance_to_border(direction: PopupDirections) -> float:
+	var viewport_rect: Rect2 = get_viewport_rect()
+	match direction:
+		PopupDirections.UP:
+			return global_position.distance_to(
+				Vector2(
+					viewport_rect.position.x + viewport_rect.size.x / 2, viewport_rect.position.y
+				)
+			)
+		PopupDirections.DOWN:
+			return global_position.distance_to(
+				Vector2(viewport_rect.position.x + viewport_rect.size.x / 2, viewport_rect.end.y)
+			)
+		PopupDirections.LEFT:
+			return global_position.distance_to(
+				Vector2(
+					viewport_rect.position.x, viewport_rect.position.y + viewport_rect.size.y / 2
+				)
+			)
+		PopupDirections.RIGHT:
+			return global_position.distance_to(
+				Vector2(viewport_rect.end.x, viewport_rect.position.y + viewport_rect.size.y / 2)
+			)
+		_:
+			push_error("Invalid direction.")
+			return 0
+
+
 func get_auto_direction() -> PopupDirections:
 	var viewport_rect: Rect2 = get_viewport_rect()
 
@@ -140,6 +173,8 @@ func get_auto_direction() -> PopupDirections:
 	var closest_dir_to_border: PopupDirections
 	var smallest_value: float = INF
 
+	print(direction_dist_dict)
+
 	for direction: PopupDirections in direction_dist_dict:
 		var value: float = direction_dist_dict[direction]
 		if value < smallest_value:
@@ -160,32 +195,52 @@ func get_auto_direction() -> PopupDirections:
 			return popup_dir
 
 
-func adjust_position(direction: PopupDirections):
-	var target_size: Vector2 = get_target().size
+func adjust_expansion(direction: PopupDirections):
+	var target_rect: Rect2 = get_target().get_rect()
 
 	match direction:
 		PopupDirections.UP:
-			position = Vector2(target_size.x / 2, 0)
-			panel.grow_horizontal = Control.GROW_DIRECTION_BOTH
+			position.y = 0
 			panel.grow_vertical = Control.GROW_DIRECTION_BEGIN
 
 		PopupDirections.DOWN:
-			position = Vector2(target_size.x / 2, target_size.y)
-			panel.grow_horizontal = Control.GROW_DIRECTION_BOTH
+			position.y = target_rect.size.y
 			panel.grow_vertical = Control.GROW_DIRECTION_END
 
 		PopupDirections.LEFT:
-			position = Vector2(0, target_size.y / 2)
+			position.x = 0
 			panel.grow_horizontal = Control.GROW_DIRECTION_BEGIN
-			panel.grow_vertical = Control.GROW_DIRECTION_BOTH
 
 		PopupDirections.RIGHT:
-			position = Vector2(target_size.x, target_size.y / 2)
+			position.x = target_rect.size.x
 			panel.grow_horizontal = Control.GROW_DIRECTION_END
-			panel.grow_vertical = Control.GROW_DIRECTION_BOTH
 
 		_:
 			push_error("Invalid direction." + str(direction))
+			return
+
+	#Adjust the remaining direction of growth.
+	if direction == PopupDirections.UP or direction == PopupDirections.DOWN:
+		#If close to the left border, extend to the right.
+		if (
+			get_distance_to_border(PopupDirections.LEFT)
+			< get_distance_to_border(PopupDirections.RIGHT)
+		):
+			panel.grow_horizontal = Control.GROW_DIRECTION_END
+		#If close to the right border...
+		else:
+			panel.grow_horizontal = Control.GROW_DIRECTION_BEGIN
+
+	elif direction == PopupDirections.LEFT or direction == PopupDirections.RIGHT:
+		#If close to the upper border, extend down.
+		if (
+			get_distance_to_border(PopupDirections.UP)
+			< get_distance_to_border(PopupDirections.DOWN)
+		):
+			panel.grow_vertical = Control.GROW_DIRECTION_END
+		#If close to the down border...
+		else:
+			panel.grow_vertical = Control.GROW_DIRECTION_BEGIN
 
 
 func update_size():
@@ -200,12 +255,10 @@ func update_input_processing():
 		label.mouse_filter = Control.MOUSE_FILTER_PASS
 	else:
 		label.mouse_filter = Control.MOUSE_FILTER_IGNORE
-		pass
 
 
 func update_rich_text():
 	var enriched_text: String
-	#var word_ranges: Array[Vector2i]
 
 	var words: PackedStringArray = text.split(" ")
 	var resulting_words: PackedStringArray = words.duplicate()
@@ -229,25 +282,6 @@ func update_rich_text():
 	label.parse_bbcode(enriched_text)
 
 
-#func update_keyword_rects():
-#var to_fill: Array[Rect2]
-#
-#for keyword: String in sub_tooltips_to_display.keys():
-#var last_find_index: int = 0
-#while last_find_index != -1:
-#last_find_index = label.text.find(keyword, last_find_index + 1)
-#
-#if last_find_index == -1:
-#continue
-#
-#var text_rect: Rect2 = calculate_word_position(label, last_find_index, last_find_index + keyword.length())
-#
-#to_fill.append(text_rect)
-#
-#keyword_rect_dict[keyword] = to_fill
-#print(keyword_rect_dict)
-
-
 func on_target_gui_input(event: InputEvent):
 	if event.is_action_pressed(pin_action):
 		pinned = !pinned
@@ -263,19 +297,21 @@ func on_visibility_update_required():
 
 	if pinned:
 		show()
+		return
+
 	elif target_hovered:
 		show()
+
 	elif not target_hovered:
 		hide()
 
 	if auto_choose_direction:
 		popup_dir = get_auto_direction()
 
-	adjust_position(popup_dir)
+	adjust_expansion(popup_dir)
 	update_size()
 	update_input_processing()
 	update_rich_text()
-	#update_keyword_rects()
 
 	queue_redraw()
 	label.queue_redraw()
@@ -291,10 +327,10 @@ func on_label_meta_hover_change(meta, hovered: bool):
 		sub_tooltip.hide()
 
 
-static func add_to_control(target: Control, sub: bool = false) -> Tooltip:
+static func add_to_control(target: Control, is_sub: bool = false) -> Tooltip:
 	var new_tooltip := Tooltip.new()
-	new_tooltip.sub = sub
-	if sub:
+	new_tooltip.sub = is_sub
+	if is_sub:
 		target.add_child(new_tooltip, false, Node.INTERNAL_MODE_FRONT)
 	else:
 		target.add_child(new_tooltip)

project.godot

@@ -167,6 +167,11 @@ j_continue={
 , Object(InputEventMouseButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"button_mask":1,"position":Vector2(133, 6),"global_position":Vector2(137, 47),"factor":1.0,"button_index":1,"canceled":false,"pressed":true,"double_click":false,"script":null)
 ]
 }
+j_pin_tooltip={
+"deadzone": 0.5,
+"events": [Object(InputEventMouseButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"button_mask":4,"position":Vector2(200, 19),"global_position":Vector2(204, 60),"factor":1.0,"button_index":3,"canceled":false,"pressed":true,"double_click":false,"script":null)
+]
+}
 
 [internationalization]
 

scenes/player/gamemenu/GameMenu.tscn

@@ -1,7 +1,8 @@
-[gd_scene load_steps=3 format=3 uid="uid://dssmk0m8xsvxf"]
+[gd_scene load_steps=4 format=3 uid="uid://dssmk0m8xsvxf"]
 
 [ext_resource type="Theme" uid="uid://dreboohjjcn2f" path="res://assets/themes/LoginPanelTheme.tres" id="1_yn42h"]
 [ext_resource type="Script" path="res://scenes/player/gamemenu/GameMenu.gd" id="2_dg6jl"]
+[ext_resource type="Script" path="res://classes/Tooltip.gd" id="3_l1agu"]
 
 [node name="GameMenu" type="PanelContainer"]
 anchors_preset = 15
@@ -52,6 +53,12 @@ layout_mode = 2
 text = "I'm Stuck Help!
 "
 
+[node name="Tooltip" type="Node2D" parent="MarginContainer/VBoxContainer/UnstuckButtonMarginContainer/UnstuckButton"]
+script = ExtResource("3_l1agu")
+pin_action = ""
+text = "Kills you instantly!
+This allows you to respawn at a proper, non-stuck location."
+
 [node name="QuitButtonMarginContainer" type="MarginContainer" parent="MarginContainer/VBoxContainer"]
 layout_mode = 2
 

scenes/player/shop/Shop.tscn

@@ -1,7 +1,8 @@
-[gd_scene load_steps=3 format=3 uid="uid://dy1r3n0fpuneq"]
+[gd_scene load_steps=4 format=3 uid="uid://dy1r3n0fpuneq"]
 
 [ext_resource type="Script" path="res://scenes/player/shop/Shop.gd" id="1_wtd5h"]
 [ext_resource type="PackedScene" uid="uid://dws3rqcdwrf43" path="res://scenes/player/shop/ShopPanel.tscn" id="2_g77pf"]
+[ext_resource type="Script" path="res://classes/Tooltip.gd" id="3_5m8cc"]
 
 [node name="Shop" type="Panel"]
 offset_right = 269.0
@@ -120,3 +121,11 @@ offset_right = 20.0
 grow_horizontal = 2
 grow_vertical = 0
 metadata/_edit_lock_ = true
+
+[node name="Tooltip" type="Node2D" parent="."]
+script = ExtResource("3_5m8cc")
+text = "Right click on a shop item to buy it. The number shown depicts the cost in gold."
+sub_tooltips_to_display = {
+"gold": "Currency, duh.",
+"help": ""
+}

scenes/player/shortcutmenu/ShortcutMenu.tscn

@@ -1,8 +1,9 @@
-[gd_scene load_steps=10 format=3 uid="uid://d261xncd2la2h"]
+[gd_scene load_steps=11 format=3 uid="uid://d261xncd2la2h"]
 
 [ext_resource type="Script" path="res://scenes/player/shortcutmenu/ShortcutMenu.gd" id="1_faslu"]
 [ext_resource type="Texture2D" uid="uid://dqw4dsidoi5wf" path="res://assets/images/icons/789_Lorc_RPG_icons/scaled/Icon.5_85.png" id="1_ryg2n"]
 [ext_resource type="Texture2D" uid="uid://cwgm6exidxs08" path="res://assets/images/icons/789_Lorc_RPG_icons/scaled/Icon.3_83.png" id="2_481p7"]
+[ext_resource type="Script" path="res://classes/Tooltip.gd" id="3_01qcm"]
 [ext_resource type="Texture2D" uid="uid://ceoisjqj6obhb" path="res://assets/images/icons/789_Lorc_RPG_icons/scaled/Icon.6_94.png" id="3_upl7j"]
 [ext_resource type="Texture2D" uid="uid://5xbd6go3j1y6" path="res://assets/images/icons/789_Lorc_RPG_icons/scaled/Icon.6_37.png" id="4_pds2v"]
 
@@ -26,20 +27,44 @@ layout_mode = 2
 texture_normal = ExtResource("1_ryg2n")
 texture_pressed = SubResource("CanvasTexture_djxay")
 
+[node name="Tooltip" type="Node2D" parent="HBoxContainer/GameMenuButton"]
+script = ExtResource("3_01qcm")
+auto_choose_direction = false
+popup_dir = 1
+text = "Main menu."
+
 [node name="StatsButton" type="TextureButton" parent="HBoxContainer"]
 unique_name_in_owner = true
 layout_mode = 2
 texture_normal = ExtResource("2_481p7")
 texture_pressed = SubResource("CanvasTexture_05pst")
 
+[node name="Tooltip" type="Node2D" parent="HBoxContainer/StatsButton"]
+script = ExtResource("3_01qcm")
+auto_choose_direction = false
+popup_dir = 1
+text = "Stats menu."
+
 [node name="EquipmentButton" type="TextureButton" parent="HBoxContainer"]
 unique_name_in_owner = true
 layout_mode = 2
 texture_normal = ExtResource("3_upl7j")
 texture_pressed = SubResource("CanvasTexture_3vu0y")
 
+[node name="Tooltip" type="Node2D" parent="HBoxContainer/EquipmentButton"]
+script = ExtResource("3_01qcm")
+auto_choose_direction = false
+popup_dir = 1
+text = "Equipment menu."
+
 [node name="BagButton" type="TextureButton" parent="HBoxContainer"]
 unique_name_in_owner = true
 layout_mode = 2
 texture_normal = ExtResource("4_pds2v")
 texture_pressed = SubResource("CanvasTexture_x2us5")
+
+[node name="Tooltip" type="Node2D" parent="HBoxContainer/BagButton"]
+script = ExtResource("3_01qcm")
+auto_choose_direction = false
+popup_dir = 1
+text = "Inventory."