Screentips

beestation.dme

@@ -163,6 +163,7 @@
 #include "code\__DEFINES\roundend.dm"
 #include "code\__DEFINES\rust_g.dm"
 #include "code\__DEFINES\say.dm"
+#include "code\__DEFINES\screentips.dm"
 #include "code\__DEFINES\SDQL.dm"
 #include "code\__DEFINES\security.dm"
 #include "code\__DEFINES\shuttles.dm"
@@ -479,6 +480,7 @@
 #include "code\controllers\subsystem\radio.dm"
 #include "code\controllers\subsystem\research.dm"
 #include "code\controllers\subsystem\runechat.dm"
+#include "code\controllers\subsystem\screentip.dm"
 #include "code\controllers\subsystem\security_level.dm"
 #include "code\controllers\subsystem\server_maint.dm"
 #include "code\controllers\subsystem\shuttle.dm"
@@ -3859,6 +3861,13 @@
 #include "code\modules\ruins\spaceruin_code\spacehotel.dm"
 #include "code\modules\ruins\spaceruin_code\TheDerelict.dm"
 #include "code\modules\ruins\spaceruin_code\whiteshipruin_box.dm"
+#include "code\modules\screentips\atom_extensions.dm"
+#include "code\modules\screentips\client_extensions.dm"
+#include "code\modules\screentips\debug_verbs.dm"
+#include "code\modules\screentips\hud_extensions.dm"
+#include "code\modules\screentips\screentip_cache.dm"
+#include "code\modules\screentips\screentip_context.dm"
+#include "code\modules\screentips\screentip_hud.dm"
 #include "code\modules\security\genpop.dm"
 #include "code\modules\security\prison_scanner.dm"
 #include "code\modules\security\workshop.dm"

code/__DEFINES/dcs/signals/signals_atom/signals_atom.dm

@@ -166,3 +166,10 @@
 
 #define COMSIG_ATOM_JAMMED "become_jammed"						//! Relayed to atoms when they become jammed if they have the jam_receiver components.
 #define COMSIG_ATOM_UNJAMMED "become_unjammed"					//! Relayed to atoms when they become unjammed if they have the jam_receiver components.
+
+/////////////////
+/// Screentip signals
+/////////////////
+
+/// proc/add_context(datum/source, datum/screentip_context/context, mob/user, obj/item/item)
+#define COMSIG_ATOM_ADD_CONTEXT "add_screentip_context"

code/__DEFINES/layers.dm

@@ -179,6 +179,8 @@
 #define HUD_PLANE 1000
 #define HUD_LAYER 25
 #define HUD_RENDER_TARGET "HUD_PLANE"
+/// Layer for screentips
+#define SCREENTIP_LAYER 26
 
 #define ABOVE_HUD_PLANE 1100
 #define ABOVE_HUD_RENDER_TARGET "ABOVE_HUD_PLANE"

code/__DEFINES/screentips.dm

@@ -0,0 +1,53 @@
+
+#define HINT_ICON_FILE 'icons/ui_icons/screentips/cursor_hints.dmi'
+#define HINT_TOOL_ICON_FILE 'icons/ui_icons/screentips/tool_hints.dmi'
+
+/// Stores the cursor hint icons for screentip context.
+GLOBAL_LIST_INIT_TYPED(screentip_context_icons, /image, prepare_screentip_context_icons())
+
+// These invisible tokens are added to fix a byond rendering bug where icons don't properly position themselves if they are the first thing on a new line
+GLOBAL_VAR_INIT(lmb_icon, "<span style='font-size: 1px'>.</span>\icon[GLOB.screentip_context_icons["LMB"]]")
+GLOBAL_VAR_INIT(rmb_icon, "<span style='font-size: 1px'>.</span>\icon[GLOB.screentip_context_icons["RMB"]]")
+GLOBAL_VAR_INIT(hint_screwdriver, "<span style='font-size: 1px'>.</span>\icon[GLOB.screentip_context_icons["screwdriver"]]")
+GLOBAL_VAR_INIT(hint_wrench, "<span style='font-size: 1px'>.</span>\icon[GLOB.screentip_context_icons["wrench"]]")
+GLOBAL_VAR_INIT(hint_crowbar, "<span style='font-size: 1px'>.</span>\icon[GLOB.screentip_context_icons["crowbar"]]")
+GLOBAL_VAR_INIT(hint_wirecutters, "<span style='font-size: 1px'>.</span>\icon[GLOB.screentip_context_icons["wirecutters"]]")
+GLOBAL_VAR_INIT(hint_welder, "<span style='font-size: 1px'>.</span>\icon[GLOB.screentip_context_icons["welder"]]")
+GLOBAL_VAR_INIT(hint_multitool, "<span style='font-size: 1px'>.</span>\icon[GLOB.screentip_context_icons["multitool"]]")
+GLOBAL_VAR_INIT(hint_knife, "<span style='font-size: 1px'>.</span>\icon[GLOB.screentip_context_icons["knife"]]")
+GLOBAL_VAR_INIT(hint_rolling_pin, "<span style='font-size: 1px'>.</span>\icon[GLOB.screentip_context_icons["rolling_pin"]]")
+
+/proc/prepare_screentip_context_icons()
+	var/list/output = list()
+	for(var/state in icon_states(HINT_ICON_FILE))
+		output[state] = image(HINT_ICON_FILE, icon_state = state)
+	for(var/state in icon_states(HINT_TOOL_ICON_FILE))
+		output[state] = image(HINT_TOOL_ICON_FILE, icon_state = state)
+	return output
+
+#define SCREEN_TIP_ALLOWED "#a9f59d"
+#define SCREEN_TIP_REJECTED "#e39191"
+#define SCREEN_TIP_NORMAL "#daf3f2"
+#define SCREEN_TIP_INACCESSIBLE "#a1b6b5"
+
+// ============================
+// Auto-tips: Developer QOL
+// ============================
+
+GLOBAL_LIST_INIT(screentips_cache, init_autotips())
+
+#define SCREENTIP_ATTACK_HAND(type, message) /datum/screentip_cache##type/attack_hand = "\n" + "<span class='maptext'><span style='line-height: 0.35; color:" + SCREEN_TIP_NORMAL + "'><center>%LMB% " + message + "</center></span></span>"
+
+/proc/init_autotips()
+	. = list()
+	for (var/datum/screentip_cache/type as anything in subtypesof(/datum/screentip_cache))
+		// Parent type, not a real type
+		if (!initial(type.attack_hand))
+			continue
+		var/path = text2path(copytext("[type]", 23))
+		var/datum/screentip_cache/cache = new type
+		cache.attack_hand = replacetext(cache.attack_hand, "%LMB%", GLOB.lmb_icon)
+		.["[path]"] = cache
+		for (var/subtype in subtypesof(path))
+			if (!.["[subtype]"])
+				.["[subtype]"] = cache

code/__DEFINES/subsystems.dm

@@ -191,6 +191,7 @@
 #define FIRE_PRIORITY_RESEARCH		10
 #define FIRE_PRIORITY_VIS			10
 #define FIRE_PRIORITY_ZCOPY			10
+#define FIRE_PRIORITY_SCREENTIPS	10	// Don't spend a lot of time on this
 #define FIRE_PRIORITY_GARBAGE		15
 #define FIRE_PRIORITY_DATABASE 16
 #define FIRE_PRIORITY_PARALLAX		18

code/_onclick/hud/action_button.dm

@@ -163,10 +163,10 @@
 	. += hidden ? show_appearance : hide_appearance
 
 /atom/movable/screen/movable/action_button/MouseEntered(location,control,params)
+	..()
 	if(!QDELETED(src))
 		openToolTip(usr,src,params,title = name,content = desc,theme = actiontooltipstyle)
 
-
 /atom/movable/screen/movable/action_button/MouseExited()
 	closeToolTip(usr)
 

code/_onclick/hud/alert.dm

@@ -102,10 +102,10 @@
 	var/obj/master
 
 /atom/movable/screen/alert/MouseEntered(location,control,params)
+	..()
 	if(!QDELETED(src))
 		openToolTip(usr,src,params,title = name,content = desc,theme = alerttooltipstyle)
 
-
 /atom/movable/screen/alert/MouseExited()
 	closeToolTip(usr)
 

code/_onclick/hud/blob_overmind.dm

@@ -3,6 +3,7 @@
 	icon = 'icons/hud/actions/actions_blob.dmi'
 
 /atom/movable/screen/blob/MouseEntered(location,control,params)
+	..()
 	openToolTip(usr,src,params,title = name,content = desc, theme = "blob")
 
 /atom/movable/screen/blob/MouseExited()

code/_onclick/hud/ghost.dm

@@ -2,6 +2,7 @@
 	icon = 'icons/hud/screen_ghost.dmi'
 
 /atom/movable/screen/ghost/MouseEntered()
+	..()
 	flick(icon_state + "_anim", src)
 
 /atom/movable/screen/ghost/jumptomob

code/_onclick/hud/holoparasite.dm

@@ -152,6 +152,7 @@ CREATION_TEST_IGNORE_SUBTYPES(/atom/movable/screen/holoparasite)
 	return ..()
 
 /atom/movable/screen/holoparasite/MouseEntered(location, control, params)
+	..()
 	if(QDELETED(src))
 		return
 	if(usr == owner)

code/_onclick/hud/screen_objects.dm

@@ -11,6 +11,7 @@
 	name = ""
 	icon = 'icons/hud/screen_gen.dmi'
 	plane = HUD_PLANE
+	layer = HUD_LAYER
 	animate_movement = SLIDE_STEPS
 	speech_span = SPAN_ROBOT
 	vis_flags = VIS_INHERIT_PLANE
@@ -491,6 +492,7 @@ CREATION_TEST_IGNORE_SUBTYPES(/atom/movable/screen/storage)
 	return set_selected_zone(choice, usr)
 
 /atom/movable/screen/zone_sel/MouseEntered(location, control, params)
+	..()
 	MouseMove(location, control, params)
 
 /atom/movable/screen/zone_sel/MouseMove(location, control, params)

code/_onclick/telekinesis.dm

@@ -86,6 +86,7 @@
 	w_class = WEIGHT_CLASS_GIGANTIC
 
 	plane = ABOVE_HUD_PLANE
+	layer = HUD_LAYER
 
 	var/atom/movable/focus = null
 	var/mob/living/carbon/tk_user = null

code/controllers/subsystem/screentip.dm

@@ -0,0 +1,33 @@
+SUBSYSTEM_DEF(screentips)
+	name = "screentips"
+	wait = 1
+	// Allocated a relatively small amount of processing time
+	priority = FIRE_PRIORITY_SCREENTIPS
+	flags = SS_NO_INIT | SS_TICKER
+	// Head of the scanning loop
+	var/client/head = null
+
+/datum/controller/subsystem/screentips/fire(resumed)
+	while (head != null && !MC_TICK_CHECK)
+		if (QDELETED(head.hovered_atom) || head.screentip_last_process == times_fired)
+			head.hovered_atom = null
+			head = head.screentip_next
+			continue
+		head.hovered_atom.on_mouse_enter(head)
+		head.hovered_atom = null
+		head.screentip_last_process = times_fired
+		head = head.screentip_next
+
+/datum/controller/subsystem/screentips/proc/on_client_disconnected(client/target)
+	SHOULD_NOT_SLEEP(TRUE)
+	var/client/current = head
+	if (current == target)
+		head = current.screentip_next
+		return
+	while (current != null)
+		var/client/next = current.screentip_next
+		if (next != target)
+			current = next
+			continue
+		current.screentip_next = next.screentip_next
+		return

code/datums/ai/dog/dog_controller.dm

@@ -30,6 +30,7 @@
 	RegisterSignal(new_pawn, COMSIG_PARENT_EXAMINE, PROC_REF(on_examined))
 	RegisterSignal(new_pawn, COMSIG_CLICK_ALT, PROC_REF(check_altclicked))
 	RegisterSignals(new_pawn, list(COMSIG_MOB_DEATH, COMSIG_PARENT_QDELETING), PROC_REF(on_death))
+	RegisterSignal(new_pawn, COMSIG_ATOM_ADD_CONTEXT, PROC_REF(add_context))
 	RegisterSignal(SSdcs, COMSIG_GLOB_CARBON_THROW_THING, PROC_REF(listened_throw))
 	return ..() //Run parent at end
 
@@ -273,3 +274,9 @@
 			if(living_pawn.buckled)
 				queue_behavior(/datum/ai_behavior/resist)//in case they are in bed or something
 			queue_behavior(/datum/ai_behavior/harass)
+
+/datum/ai_controller/dog/proc/add_context(datum/source, datum/screentip_context/context, mob/user)
+	if (user.a_intent == INTENT_HARM)
+		context.add_attack_hand_action("Punch")
+	else
+		context.add_attack_hand_action("Pet")

code/datums/brain_damage/special.dm

@@ -144,6 +144,10 @@
 			user.visible_message("<span class='warning'>[user] [slip_in_message].</span>", null, null, null, user)
 			user.visible_message("<span class='warning'>[user] [slip_out_message].</span>", "<span class='notice'>...and find your way to the other side.</span>")
 
+/obj/effect/hallucination/simple/bluespace_stream/add_context_self(datum/screentip_context/context, mob/user, obj/item/item)
+	context.use_cache()
+	context.add_attack_hand_action("Teleport")
+
 /datum/brain_trauma/special/tenacity
 	name = "Tenacity"
 	desc = "Patient is psychologically unaffected by pain and injuries, and can remain standing far longer than a normal person."

code/datums/elements/climbable.dm

@@ -50,7 +50,6 @@
 		structure_climber.Paralyze(40)
 		structure_climber.visible_message("<span class='warning'>[structure_climber] is knocked off [climbed_thing].</span>", "<span class='warning'>You're knocked off [climbed_thing]!</span>", "<span class='hear'>You hear a cry from [structure_climber], followed by a slam.</span>")
 
-
 /datum/element/climbable/proc/climb_structure(atom/climbed_thing, mob/living/user, params)
 	if(!can_climb(climbed_thing, user))
 		return

code/game/machinery/PDApainter.dm

@@ -220,6 +220,18 @@
 		storedid = null
 		update_icon()
 
+/obj/machinery/pdapainter/add_context_self(datum/screentip_context/context, mob/user, obj/item/item)
+	context.use_cache()
+	if(storedpda || storedid)
+		context.add_attack_hand_action("Paint Item")
+		context.add_alt_click_action("Eject Item")
+	else
+		context.add_left_click_item_action("Insert", /obj/item/modular_computer/tablet/pda)
+		context.add_left_click_item_action("Insert", /obj/item/card/id)
+	if (machine_stat & BROKEN)
+		context.add_left_click_tool_action("Repair", TOOL_WELDER)
+	context.add_generic_unfasten_actions(src)
+
 /proc/get_card_style_list(emagged)
 	var/static/valid_jobs = list(
 		"----Command----", "Command (Custom)",JOB_NAME_CAPTAIN,"Acting Captain",

code/game/machinery/airlock_control.dm

@@ -1,10 +1,9 @@
 #define AIRLOCK_CONTROL_RANGE 5
 
 // This code allows for airlocks to be controlled externally by setting an id_tag and comm frequency (disables ID access)
-/obj/machinery/door/airlock
-	var/frequency
-	var/datum/radio_frequency/radio_connection
-	smoothing_groups = list(SMOOTH_GROUP_AIRLOCK)
+/obj/machinery/door/airlock/var/frequency
+/obj/machinery/door/airlock/var/datum/radio_frequency/radio_connection
+/obj/machinery/door/airlock/smoothing_groups = list(SMOOTH_GROUP_AIRLOCK)
 
 /obj/machinery/door/airlock/receive_signal(datum/signal/signal)
 	if(!signal)
@@ -120,6 +119,8 @@
 	else
 		icon_state = "airlock_sensor_off"
 
+SCREENTIP_ATTACK_HAND(/obj/machinery/airlock_sensor, "Use")
+
 /obj/machinery/airlock_sensor/attack_hand(mob/user)
 	. = ..()
 	if(.)

code/game/machinery/airlock_cycle_control.dm

@@ -825,8 +825,7 @@
 		new /obj/item/stack/cable_coil(loc, 3)
 	qdel(src)
 
-/obj/machinery/door/airlock
-	var/obj/machinery/advanced_airlock_controller/aac
+/obj/machinery/door/airlock/var/obj/machinery/advanced_airlock_controller/aac
 
 /obj/machinery/door/airlock/Initialize(mapload)
 	. = ..()

code/game/machinery/aug_manipulator.dm

@@ -93,6 +93,8 @@
 	else
 		return ..()
 
+SCREENTIP_ATTACK_HAND(/obj/machinery/aug_manipulator, "Use")
+
 /obj/machinery/aug_manipulator/attack_hand(mob/user)
 	. = ..()
 	if(.)

code/game/machinery/buttons.dm

@@ -298,3 +298,19 @@ MAPPING_DIRECTIONAL_HELPERS(/obj/machinery/button/shieldwallgen, 24)
 
 /obj/machinery/button/shieldwallgen/connect_to_shuttle(obj/docking_port/mobile/port, obj/docking_port/stationary/dock)
 	id = "[REF(port)][id]"
+
+/obj/machinery/button/add_context_self(datum/screentip_context/context, mob/user)
+	if (length(req_access) || length(req_one_access) || req_access_txt != "0" || req_one_access_txt != "0")
+		context.add_access_context("Access Required", allowed(user))
+	if (context.accept_silicons())
+		if (!panel_open)
+			context.add_attack_hand_action("Activate")
+		return
+	if (panel_open)
+		if(device || board)
+			context.add_attack_hand_action("Remove Electronics")
+		else
+			context.add_attack_hand_action("Change Appearance")
+	else
+		context.add_attack_hand_action("Push")
+	context.add_left_click_item_action("Hack", /obj/item/card/emag)

code/game/machinery/cell_charger.dm

@@ -130,3 +130,12 @@
 	charging.give(charge_rate * delta_time)	//this is 2558, efficient batteries exist
 
 	update_icon()
+
+/obj/machinery/cell_charger/add_context_self(datum/screentip_context/context, mob/user)
+	if (charging)
+		context.add_attack_hand_action("Take Item")
+	if (!panel_open)
+		context.add_left_click_item_action("Charge Item", /obj/item/stock_parts/cell)
+	if (!charging)
+		context.add_generic_deconstruction_actions(src)
+		context.add_generic_unfasten_actions(src, TRUE)

code/game/machinery/cloning.dm

@@ -90,6 +90,8 @@
 	if(heal_level > 100)
 		heal_level = 100
 
+SCREENTIP_ATTACK_HAND(/obj/machinery/clonepod, "Examine")
+
 /obj/machinery/clonepod/attack_hand(mob/user)
 	. = ..()
 	if(.)

code/game/machinery/computer/_computer.dm

@@ -165,3 +165,9 @@
 		for(var/obj/C in src)
 			C.forceMove(loc)
 	qdel(src)
+
+/obj/machinery/computer/add_context_self(datum/screentip_context/context, mob/user, obj/item/item)
+	context.use_cache()
+	context.add_attack_hand_action("Interact")
+	if(circuit && !(flags_1&NODECONSTRUCT_1))
+		context.add_left_click_tool_action("Deconstruct", TOOL_SCREWDRIVER)

code/game/machinery/computer/arcade.dm

@@ -1234,6 +1234,8 @@ GLOBAL_LIST_INIT(arcade_prize_pool, list(
 	icon_state = "arcade"
 	circuit = /obj/item/circuitboard/computer/arcade/amputation
 
+SCREENTIP_ATTACK_HAND(/obj/machinery/computer/arcade/amputation, "Use")
+
 /obj/machinery/computer/arcade/amputation/attack_hand(mob/user)
 	if(!iscarbon(user))
 		return

code/game/machinery/computer/camera_advanced.dm

@@ -165,6 +165,8 @@
 		return FALSE
 	return ..()
 
+SCREENTIP_ATTACK_HAND(/obj/machinery/computer/camera_advanced, "Use")
+
 /obj/machinery/computer/camera_advanced/attack_hand(mob/user)
 	. = ..()
 	if(.)

code/game/machinery/defibrillator_mount.dm

@@ -73,6 +73,8 @@ MAPPING_DIRECTIONAL_HELPERS(/obj/machinery/defibrillator_mount/loaded, 28)
 	if(defib)
 		return defib.get_cell()
 
+SCREENTIP_ATTACK_HAND(/obj/machinery/defibrillator_mount, "Use")
+
 //defib interaction
 /obj/machinery/defibrillator_mount/attack_hand(mob/living/user)
 	if(!defib)