Merge pull request #7928 from MistakeNot4892/gps

Added a GPS compass.

code/game/objects/items/devices/gps.dm

@@ -9,6 +9,7 @@ var/list/GPS_list = list()
 	slot_flags = SLOT_BELT
 	origin_tech = list(TECH_MATERIAL = 2, TECH_BLUESPACE = 2, TECH_MAGNET = 1)
 	matter = list(DEFAULT_WALL_MATERIAL = 500)
+
 	var/gps_tag = "GEN0"
 	var/emped = FALSE
 	var/tracking = FALSE		// Will not show other signals or emit its own signal if false.
@@ -17,15 +18,110 @@ var/list/GPS_list = list()
 	var/hide_signal = FALSE		// If true, signal is not visible to other GPS devices.
 	var/can_hide_signal = FALSE	// If it can toggle the above var.
 
+	var/mob/holder
+	var/is_in_processing_list = FALSE
+	var/list/tracking_devices
+	var/list/showing_tracked_names
+	var/obj/compass_holder/compass
+
 /obj/item/device/gps/Initialize()
 	. = ..()
+	compass = new(src)
 	GPS_list += src
 	name = "global positioning system ([gps_tag])"
+	update_holder()
 	update_icon()
 
+/obj/item/device/gps/proc/check_visible_to_holder()
+	. = (holder && (holder.get_active_hand() == src || holder.get_inactive_hand() == src))
+
+/obj/item/device/gps/proc/update_holder()
+
+	if(holder && loc != holder)
+		GLOB.moved_event.unregister(holder, src)
+		GLOB.dir_set_event.unregister(holder, src)
+		holder.client?.screen -= compass
+		holder = null
+
+	if(istype(loc, /mob))
+		holder = loc
+		GLOB.moved_event.register(holder, src, .proc/update_compass)
+		GLOB.dir_set_event.register(holder, src, .proc/update_compass)
+
+	if(holder && tracking)
+		if(!is_in_processing_list)
+			START_PROCESSING(SSobj, src)
+			is_in_processing_list = TRUE
+		if(holder.client)
+			if(check_visible_to_holder())
+				holder.client.screen |= compass
+			else
+				holder.client.screen -= compass
+	else
+		STOP_PROCESSING(SSobj, src)
+		is_in_processing_list = FALSE
+		if(holder?.client)
+			holder.client.screen -= compass
+
+/obj/item/device/gps/pickup()
+	. = ..()
+	update_holder()
+
+/obj/item/device/gps/equipped()
+	. = ..()
+	update_holder()
+
+/obj/item/device/gps/dropped()
+	. = ..()
+	update_holder()
+
+/obj/item/device/gps/process()
+	if(!tracking)
+		is_in_processing_list = FALSE
+		return PROCESS_KILL
+	update_holder()
+	if(holder)
+		update_compass(TRUE)
+
 /obj/item/device/gps/Destroy()
+	STOP_PROCESSING(SSobj, src)
+	is_in_processing_list = FALSE
 	GPS_list -= src
-	return ..()
+	. = ..()
+	update_holder()
+	QDEL_NULL(compass)
+
+/obj/item/device/gps/proc/can_track(var/obj/item/device/gps/other, var/reachable_z_levels)
+	if(!other.tracking || other.emped || other.hide_signal)
+		return FALSE
+	var/turf/origin = get_turf(src)
+	var/turf/target = get_turf(other)
+	if(!istype(origin) || !istype(target))
+		return FALSE
+	if(origin.z == target.z)
+		return TRUE
+	if(local_mode)
+		return FALSE
+	reachable_z_levels = reachable_z_levels || using_map.get_map_levels(origin.z, long_range)
+	return (target.z in reachable_z_levels)
+
+/obj/item/device/gps/proc/update_compass(var/update_compass_icon)
+	compass.hide_waypoints(FALSE)
+	for(var/thing in tracking_devices)
+		var/obj/item/device/gps/gps = locate(thing)
+		if(!istype(gps) || QDELETED(gps))
+			LAZYREMOVE(tracking_devices, thing)
+			LAZYREMOVE(showing_tracked_names, thing)
+			continue
+		var/turf/gps_turf = get_turf(gps)
+		var/gps_tag = LAZYACCESS(showing_tracked_names, thing) ? gps.gps_tag : null
+		if(istype(gps_turf))
+			compass.set_waypoint("\ref[gps]", gps_tag, gps_turf.x, gps_turf.y, gps_turf.z, LAZYACCESS(tracking_devices, "\ref[gps]"))
+		else
+			compass.set_waypoint("\ref[gps]", gps_tag, 0, 0, 0, LAZYACCESS(tracking_devices, "\ref[gps]"))
+		if(can_track(gps))
+			compass.show_waypoint("\ref[gps]")
+	compass.rebuild_overlay_lists(update_compass_icon)
 
 /obj/item/device/gps/AltClick(mob/user)
 	toggletracking(user)
@@ -36,14 +132,25 @@ var/list/GPS_list = list()
 	if(emped)
 		to_chat(user, "It's busted!")
 		return
+	
+	toggle_tracking()
 	if(tracking)
 		to_chat(user, "[src] is no longer tracking, or visible to other GPS devices.")
-		tracking = FALSE
-		update_icon()
 	else
 		to_chat(user, "[src] is now tracking, and visible to other GPS devices.")
-		tracking = TRUE
-		update_icon()
+
+/obj/item/device/gps/proc/toggle_tracking()
+	tracking = !tracking
+	if(tracking)
+		if(!is_in_processing_list)
+			is_in_processing_list = TRUE
+			START_PROCESSING(SSobj, src)
+	else
+		is_in_processing_list = FALSE
+		STOP_PROCESSING(SSobj, src)
+	update_compass()
+	update_holder()
+	update_icon()
 
 /obj/item/device/gps/emp_act(severity)
 	if(emped) // Without a fancy callback system, this will have to do.
@@ -85,15 +192,8 @@ var/list/GPS_list = list()
 	dat["z_level_detection"] = using_map.get_map_levels(curr.z, long_range)
 	
 	for(var/obj/item/device/gps/G in GPS_list - src)
-		if(!G.tracking || G.emped || G.hide_signal)
-			continue
 
-		var/turf/T = get_turf(G)
-		if(!T)
-			continue
-		if(local_mode && curr.z != T.z)
-			continue
-		if(!(T.z in dat["z_level_detection"]))
+		if(!can_track(G, dat["z_level_detection"]))
 			continue
 
 		var/gps_data[0]
@@ -103,6 +203,7 @@ var/list/GPS_list = list()
 		var/area/A = get_area(G)
 		gps_data["area_name"] = A.get_name()
 
+		var/turf/T = get_turf(G)
 		gps_data["z_name"] = using_map.get_zlevel_name(T.z)
 		gps_data["direction"] = get_adir(curr, T)
 		gps_data["degrees"] = round(Get_Angle(curr,T))
@@ -118,9 +219,7 @@ var/list/GPS_list = list()
 	return dat
 
 /obj/item/device/gps/proc/display(mob/user)
-	if(!tracking)
-		to_chat(user, "The device is off. Alt-click it to turn it on.")
-		return
+
 	if(emped)
 		to_chat(user, "It's busted!")
 		return
@@ -128,27 +227,93 @@ var/list/GPS_list = list()
 	var/list/dat = list()
 	var/list/gps_data = display_list()
 
-	dat += "Current location: [gps_data["my_area_name"]] <b>([gps_data["curr_x"]], [gps_data["curr_y"]], [gps_data["curr_z_name"]])</b>"
-	dat += "[hide_signal ? "Tagged" : "Broadcasting"] as '[gps_tag]'. <a href='?src=\ref[src];tag=1'>\[Change Tag\]</a> \
-	<a href='?src=\ref[src];range=1'>\[Toggle Scan Range\]</a> \
-	[can_hide_signal ? "<a href='?src=\ref[src];hide=1'>\[Toggle Signal Visibility\]</a>":""]"
-
-	if(gps_data["gps_list"].len)
-		dat += "Detected signals;"
-		for(var/gps in gps_data["gps_list"])
-			if(istype(gps_data["ref"], /obj/item/device/gps/internal/poi))
-				dat += "    [gps["gps_tag"]]: [gps["area_name"]] - [gps["local"] ? "[gps["direction"]] Dist: [round(gps["distance"], 10)]m" : "in \the [gps["z_name"]]"]"
-			else
-				dat += "    [gps["gps_tag"]]: [gps["area_name"]], ([gps["x"]], [gps["y"]]) - [gps["local"] ? "[gps["direction"]] Dist: [gps["distX"] ? "[abs(round(gps["distX"], 1))]m [(gps["distX"] > 0) ? "E" : "W"], " : ""][gps["distY"] ? "[abs(round(gps["distY"], 1))]m [(gps["distY"] > 0) ? "N" : "S"]" : ""]" : "in \the [gps["z_name"]]"]"
+	dat += "<table width = '100%'>"
+	if(!tracking)
+		dat += "<tr><td colspan = 6></td><a href='?src=\ref[src];toggle_power=1'>\[Switch On]\]</a></tr>"
 	else
-		dat += "No other signals detected."
+		dat += "<tr><td colspan = 6></td><a href='?src=\ref[src];toggle_power=1'>\[Switch Off]\]</a></tr>"
+		dat += "<tr><td colspan = 2><b>Current location</b></td><td colspan = 2>[gps_data["my_area_name"]]</td><td colspan = 2><b>([gps_data["curr_x"]], [gps_data["curr_y"]], [gps_data["curr_z_name"]])</b></td></tr>"
+		dat += "<tr><td colspan = 4>[hide_signal ? "Tagged" : "Broadcasting"] as '[gps_tag]'.</td>"
+		dat += "<td><a href='?src=\ref[src];tag=1'>\[Change Tag\]</a><a href='?src=\ref[src];range=1'>\[Toggle Scan Range\]</a>[can_hide_signal ? "<a href='?src=\ref[src];hide=1'>\[Toggle Signal Visibility\]</a>":""]</td></tr>"
 
-	var/result = dat.Join("<br>")
-	to_chat(user, result)
+		if(gps_data["gps_list"].len)
+			dat += "<tr><td colspan = 6><b>Detected signals</b></td></tr>"
+			for(var/gps in gps_data["gps_list"])
+				dat += "<tr>"
+				var/gps_ref = "\ref[gps["ref"]]"
+				dat += "<td>[gps["gps_tag"]]</td><td>[gps["area_name"]]</td>"
+				
+				if(istype(gps_data["ref"], /obj/item/device/gps/internal/poi))
+					dat += "<td>[gps["local"] ? "[gps["direction"]] Dist: [round(gps["distance"], 10)]m" : "in \the [gps["z_name"]]"]</td>"
+				else
+					dat += "<td>([gps["x"]], [gps["y"]], [gps["z_name"]])</td>"
+
+				if(gps["local"])
+					dat += "<td>[gps["distance"]]m</td>"
+					dat += "<td>[gps["degrees"]]° ([gps["direction"]])</td>"
+				else
+					dat += "<td colspan = 2>Non-local signal.</td>"
+
+				if(LAZYACCESS(tracking_devices, gps_ref))
+					dat += "<td><a href='?src=\ref[src];stop_track=[gps_ref]'>\[Stop Tracking\]</a> <a href='?src=\ref[src];track_color=[gps_ref]'>\[Colour [color_square(hex = LAZYACCESS(tracking_devices, gps_ref))]\]</a> <a href='?src=\ref[src];track_label=[gps_ref]'>Show/Hide Label</a></td>"
+				else
+					dat += "<td><a href='?src=\ref[src];start_track=[gps_ref]'>\[Start Tracking\]</a></td>"
+				dat += "</tr>"
+		else
+			dat += "<tr><td colspan = 5>No other signals detected.</td></tr>"
+	dat += "</table>"
+
+	var/datum/browser/popup = new(user, "gps_\ref[src]", "Global Positioning System", 700, 1000)
+	popup.set_content(dat.Join(null))
+	popup.open()
 
 /obj/item/device/gps/Topic(var/href, var/list/href_list)
 	if(..())
-		return 1
+		return TRUE
+
+	if(href_list["toggle_power"])
+		toggle_tracking()
+		. = TRUE
+
+	if(href_list["track_label"])
+		var/gps_ref = href_list["track_label"]
+		var/obj/item/device/gps/gps = locate(gps_ref)
+		if(istype(gps) && !QDELETED(gps) && !LAZYACCESS(showing_tracked_names, gps_ref))
+			LAZYSET(showing_tracked_names, gps_ref, TRUE)
+		else
+			LAZYREMOVE(showing_tracked_names, gps_ref)
+		to_chat(usr, SPAN_NOTICE("\The [src] is [LAZYACCESS(showing_tracked_names, gps_ref) ? "now showing" : "no longer showing"] labels for [gps.gps_tag]."))
+
+	if(href_list["stop_track"])
+		var/gps_ref = href_list["stop_track"]
+		var/obj/item/device/gps/gps = locate(gps_ref)
+		compass.clear_waypoint(gps_ref)
+		LAZYREMOVE(tracking_devices, gps_ref)
+		LAZYREMOVE(showing_tracked_names, gps_ref)
+		if(istype(gps) && !QDELETED(gps))
+			to_chat(usr, SPAN_NOTICE("\The [src] is no longer tracking [gps.gps_tag]."))
+		update_compass()
+		. = TRUE
+
+	if(href_list["start_track"])
+		var/gps_ref = href_list["start_track"]
+		var/obj/item/device/gps/gps = locate(gps_ref)
+		if(istype(gps) && !QDELETED(gps))
+			LAZYSET(tracking_devices, gps_ref, "#00ffff")
+			LAZYSET(showing_tracked_names, gps_ref, TRUE)
+			to_chat(usr, SPAN_NOTICE("\The [src] is now tracking [gps.gps_tag]."))
+			update_compass()
+			. = TRUE
+
+	if(href_list["track_color"])
+		var/obj/item/device/gps/gps = locate(href_list["track_color"])
+		if(istype(gps) && !QDELETED(gps))
+			var/new_colour = input("Enter a new tracking color.", "GPS Waypoint Color") as color|null
+			if(new_colour && istype(gps) && !QDELETED(gps) && holder == usr && !usr.incapacitated())
+				to_chat(usr, SPAN_NOTICE("You adjust the colour \the [src] is using to highlight [gps.gps_tag]."))
+				LAZYSET(tracking_devices, href_list["track_color"], new_colour)
+				update_compass()
+				. = TRUE
 
 	if(href_list["tag"])
 		var/a = input("Please enter desired tag.", name, gps_tag) as text
@@ -157,16 +322,22 @@ var/list/GPS_list = list()
 			gps_tag = a
 			name = "global positioning system ([gps_tag])"
 			to_chat(usr, "You set your GPS's tag to '[gps_tag]'.")
+			. = TRUE
 
 	if(href_list["range"])
 		local_mode = !local_mode
 		to_chat(usr, "You set the signal receiver to [local_mode ? "'NARROW'" : "'BROAD'"].")
+		. = TRUE
 
 	if(href_list["hide"])
 		if(!can_hide_signal)
 			return
 		hide_signal = !hide_signal
 		to_chat(usr, "You set the device to [hide_signal ? "not " : ""]broadcast a signal while scanning for other signals.")
+		. = TRUE
+
+	if(. && loc == usr)
+		display(usr)
 
 /obj/item/device/gps/on // Defaults to off to avoid polluting the signal list with a bunch of GPSes without owners. If you need to spawn active ones, use these.
 	tracking = TRUE
@@ -290,9 +461,7 @@ var/list/GPS_list = list()
 	can_hide_signal = TRUE
 
 /obj/item/device/gps/syndie/display(mob/user)
-	if(!tracking)
-		to_chat(user, "The device is off. Alt-click it to turn it on.")
-		return
+
 	if(emped)
 		to_chat(user, "It's busted!")
 		return
@@ -300,17 +469,35 @@ var/list/GPS_list = list()
 	var/list/dat = list()
 	var/list/gps_data = display_list()
 
-	dat += "Current location: [gps_data["my_area_name"]] <b>([gps_data["curr_x"]], [gps_data["curr_y"]], [gps_data["curr_z_name"]])</b>"
-	dat += "[hide_signal ? "Tagged" : "Broadcasting"] as '[gps_tag]'. <a href='?src=\ref[src];tag=1'>\[Change Tag\]</a> \
-	<a href='?src=\ref[src];range=1'>\[Toggle Scan Range\]</a> \
-	[can_hide_signal ? "<a href='?src=\ref[src];hide=1'>\[Toggle Signal Visibility\]</a>":""]"
-
-	if(gps_data["gps_list"].len)
-		dat += "Detected signals;"
-		for(var/gps in gps_data["gps_list"])
-			dat += "     [gps["gps_tag"]]: [gps["area_name"]] ([gps["x"]], [gps["y"]], [gps["z_name"]]) [gps["local"] ? "Dist: [gps["distance"]]m Dir: [gps["degrees"]]° ([gps["direction"]])" :""]"
+	dat += "<table width = '100%'>"
+	if(!tracking)
+		dat += "<tr><td colspan = 6></td><a href='?src=\ref[src];toggle_power=1'>\[Switch On]\]</a></tr>"
 	else
-		dat += "No other signals detected."
+		dat += "<tr><td colspan = 6></td><a href='?src=\ref[src];toggle_power=1'>\[Switch Off]\]</a></tr>"
+		dat += "<tr><td colspan = 2><b>Current location</b></td><td colspan = 2>[gps_data["my_area_name"]]</td><td colspan = 2><b>([gps_data["curr_x"]], [gps_data["curr_y"]], [gps_data["curr_z_name"]])</b></td></tr>"
+		dat += "<tr><td colspan = 4>[hide_signal ? "Tagged" : "Broadcasting"] as '[gps_tag]'.</td>"
+		dat += "<td><a href='?src=\ref[src];tag=1'>\[Change Tag\]</a><a href='?src=\ref[src];range=1'>\[Toggle Scan Range\]</a>[can_hide_signal ? "<a href='?src=\ref[src];hide=1'>\[Toggle Signal Visibility\]</a>":""]</td></tr>"
 
-	var/result = dat.Join("<br>")
-	to_chat(user, result)
+		if(gps_data["gps_list"].len)
+			dat += "<tr><td colspan = 6><b>Detected signals</b></td></tr>"
+			for(var/gps in gps_data["gps_list"])
+				dat += "<tr>"
+				var/gps_ref = "\ref[gps["ref"]]"
+				dat += "<td>[gps["gps_tag"]]</td><td>[gps["area_name"]] ([gps["x"]], [gps["y"]], [gps["z_name"]])</td>"
+				if(gps["local"])
+					dat += "<td>[gps["distance"]]m</td>"
+					dat += "<td>[gps["degrees"]]° ([gps["direction"]])</td>"
+				else
+					dat += "<td colspan = 2>Non-local signal.</td>"
+				if(LAZYACCESS(tracking_devices, gps_ref))
+					dat += "<td><a href='?src=\ref[src];stop_track=[gps_ref]'>\[Stop Tracking\]</a> <a href='?src=\ref[src];track_color=[gps_ref]'>\[Colour [color_square(hex = LAZYACCESS(tracking_devices, gps_ref))]\]</a> <a href='?src=\ref[src];track_label=[gps_ref]'>Show/Hide Label</a></td>"
+				else
+					dat += "<td><a href='?src=\ref[src];start_track=[gps_ref]'>\[Start Tracking\]</a></td>"
+				dat += "</tr>"
+		else
+			dat += "<tr><td colspan = 6>No other signals detected.</td></tr>"
+	dat += "</table>"
+
+	var/datum/browser/popup = new(user, "gps_\ref[src]", "Global Positioning System", 700, 1000)
+	popup.set_content(dat.Join(null))
+	popup.open()