Files
Bubberstation/code/modules/detectivework/scanner.dm
Andrew 2fed024d0f Forensic scanner UI and report format update (#89221)
## About The Pull Request

Added UI for the forensic scanner.

<details><summary>UI</summary>
<img alt="gRO2mae3E4"
src="https://github.com/user-attachments/assets/360832de-0485-4827-a4e1-957541cbf002"
/>
</details> 

<details><summary>Report</summary>
<img alt="99Y5ierj24"
src="https://github.com/user-attachments/assets/e14d221d-d5d0-42b1-8054-902f19780f1a"
/>
</details> 

## Why It's Good For The Game

Less things printing bunch of data in chat and using a proper UI
instead.

## Changelog

🆑
qol: Added forensic scanner UI
qol: Made forensic scanner report format cleaner
/🆑

---------

Co-authored-by: Jeremiah <42397676+jlsnow301@users.noreply.github.com>
2025-01-31 07:59:02 -08:00

271 lines
8.9 KiB
Plaintext

//CONTAINS: Detective's Scanner
/obj/item/detective_scanner
name = "forensic scanner"
desc = "Used to remotely scan objects and biomass for DNA and fingerprints. Can print a report of the findings."
icon = 'icons/obj/devices/scanner.dmi'
icon_state = "forensicnew"
w_class = WEIGHT_CLASS_SMALL
inhand_icon_state = "electronic"
worn_icon_state = "electronic"
lefthand_file = 'icons/mob/inhands/items/devices_lefthand.dmi'
righthand_file = 'icons/mob/inhands/items/devices_righthand.dmi'
obj_flags = CONDUCTS_ELECTRICITY
item_flags = NOBLUDGEON
slot_flags = ITEM_SLOT_BELT
/// if the scanner is currently busy processing
var/scanner_busy = FALSE
var/list/log_data = list()
var/range = 8
var/view_check = TRUE
var/forensicPrintCount = 0
/obj/item/detective_scanner/interact(mob/user)
. = ..()
if(user.stat != CONSCIOUS || !user.can_read(src) || user.is_blind())
return ITEM_INTERACT_BLOCKING
ui_interact(user)
return ITEM_INTERACT_SUCCESS
/**
* safe_print_report - a wrapper proc for print_report
*
* Calls print_report(), and should a runtime occur within we can still reset the 'busy' state
*/
/obj/item/detective_scanner/proc/safe_print_report()
print_report()
scanner_busy = FALSE
/obj/item/detective_scanner/proc/print_report()
// Create our paper
var/obj/item/paper/report_paper = new(get_turf(src))
//This could be a global count like sec and med record printouts. See GLOB.manifest.generalPrintCount AKA datacore.dm
var/frNum = ++forensicPrintCount
report_paper.name = "FR-[frNum] 'Forensic Record'"
var/list/report_text = list("<H1>Forensic Record - (FR-[frNum])</H1><HR>")
for(var/list/log in log_data)
report_text += "<H2>[capitalize(log["scan_target"])] scan at [log["scan_time"]]</H2><DL>"
if(!log[DETSCAN_CATEGORY_FIBER] && !log[DETSCAN_CATEGORY_BLOOD] && !log[DETSCAN_CATEGORY_FINGERS] && !log[DETSCAN_CATEGORY_DRINK] && !log[DETSCAN_CATEGORY_ACCESS])
report_text += "No forensic traces found.<HR>"
continue
if(log[DETSCAN_CATEGORY_FIBER])
report_text += "<DT><B>[DETSCAN_CATEGORY_FIBER]</B></DT><DD>"
for(var/fibers in log[DETSCAN_CATEGORY_FIBER])
report_text += fibers + "<BR>"
report_text += "</DD>"
if(log[DETSCAN_CATEGORY_BLOOD])
report_text += "<DT><B>[DETSCAN_CATEGORY_BLOOD]</B></DT><DD>"
for(var/blood in log[DETSCAN_CATEGORY_BLOOD])
report_text += "[blood], [log[DETSCAN_CATEGORY_BLOOD][blood]]<BR>"
report_text += "</DD>"
if(log[DETSCAN_CATEGORY_FINGERS])
report_text += "<DT><B>[DETSCAN_CATEGORY_FINGERS]</B></DT><DD>"
for(var/fingers in log[DETSCAN_CATEGORY_FINGERS])
report_text += fingers + "<BR>"
report_text += "</DD>"
if(log[DETSCAN_CATEGORY_DRINK])
report_text += "<DT><B>[DETSCAN_CATEGORY_DRINK]</B></DT><DD>"
for(var/reagent in log[DETSCAN_CATEGORY_DRINK])
report_text += "<B>[reagent]</B>: [log[DETSCAN_CATEGORY_DRINK][reagent]] u.<BR>"
report_text += "</DD>"
if(log[DETSCAN_CATEGORY_ACCESS])
report_text += "<DT><B>[DETSCAN_CATEGORY_ACCESS]</B></DT><DD>"
for(var/region in log[DETSCAN_CATEGORY_ACCESS])
var/list/access_list = log[DETSCAN_CATEGORY_ACCESS][region]
report_text += "<B>[region]</B>: [access_list.Join(", ")]<BR>"
report_text += "</DD>"
report_text += "</DL><HR>"
report_text += "<H1>Notes:</H1><BR>"
report_paper.add_raw_text(report_text.Join())
report_paper.update_appearance()
if(ismob(loc))
var/mob/printer = loc
printer.put_in_hands(report_paper)
balloon_alert(printer, "logs cleared")
// Clear the logs
log_data = list()
/obj/item/detective_scanner/interact_with_atom(atom/interacting_with, mob/living/user, list/modifiers)
if(SHOULD_SKIP_INTERACTION(interacting_with, src, user))
return NONE // lets us put our scanner away without trying to scan the bag
safe_scan(user, interacting_with)
return ITEM_INTERACT_SUCCESS
/obj/item/detective_scanner/ranged_interact_with_atom(atom/interacting_with, mob/living/user, list/modifiers)
safe_scan(user, interacting_with)
return ITEM_INTERACT_SUCCESS
/**
* safe_scan - a wrapper proc for scan()
*
* calls scan(), and should a runtime occur within we can still reset the 'busy' state
*/
/obj/item/detective_scanner/proc/safe_scan(mob/user, atom/atom_to_scan)
set waitfor = FALSE
if(scanner_busy)
balloon_alert(user, "scanner busy!")
return
if(!scan(user, atom_to_scan)) // this should only return FALSE if a runtime occurs during the scan proc, so ideally never
balloon_alert(user, "scanner error!") // but in case it does, we 'error' instead of just bricking the scanner
scanner_busy = FALSE
/**
* scan - scans an atom for forensic data and outputs it to the mob holding the scanner
*
* This should always return TRUE barring a runtime
*/
/obj/item/detective_scanner/proc/scan(mob/user, atom/scanned_atom)
if(loc != user)
return TRUE
// Can scan items we hold and store
if(!(scanned_atom in user.get_all_contents()))
// Can remotely scan objects and mobs.
if((get_dist(scanned_atom, user) > range) || (!(scanned_atom in view(range, user)) && view_check))
return TRUE
playsound(src, SFX_INDUSTRIAL_SCAN, 20, TRUE, -2, TRUE, FALSE)
scanner_busy = TRUE
user.visible_message(
span_notice("\The [user] points \the [src] at \the [scanned_atom] and performs a forensic scan."),
ignored_mobs = user
)
to_chat(user, span_notice("You scan \the [scanned_atom]. The scanner is now analysing the results..."))
// GATHER INFORMATION
var/list/log_entry_data = list()
// Start gathering
log_entry_data["scan_target"] = scanned_atom.name
log_entry_data["scan_time"] = station_time_timestamp()
log_entry_data[DETSCAN_CATEGORY_FIBER] = GET_ATOM_FIBRES(scanned_atom)
var/list/blood = GET_ATOM_BLOOD_DNA(scanned_atom)
if(length(blood))
LAZYADD(log_entry_data[DETSCAN_CATEGORY_BLOOD], blood)
if(ishuman(scanned_atom))
var/mob/living/carbon/human/scanned_human = scanned_atom
if(!scanned_human.gloves)
LAZYADD(log_entry_data[DETSCAN_CATEGORY_FINGERS], md5(scanned_human.dna?.unique_identity))
else if(!ismob(scanned_atom))
log_entry_data[DETSCAN_CATEGORY_FINGERS] = GET_ATOM_FINGERPRINTS(scanned_atom)
// Only get reagents from non-mobs.
for(var/datum/reagent/present_reagent as anything in scanned_atom.reagents?.reagent_list)
LAZYADD(log_entry_data[DETSCAN_CATEGORY_DRINK], list(present_reagent.name = present_reagent.volume))
// Get blood data from the blood reagent.
if(!istype(present_reagent, /datum/reagent/blood))
continue
var/blood_DNA = present_reagent.data["blood_DNA"]
var/blood_type = present_reagent.data["blood_type"]
if(!blood_DNA || !blood_type)
continue
LAZYSET(blood, blood_DNA, blood_type)
if(istype(scanned_atom, /obj/item/card/id))
var/obj/item/card/id/user_id = scanned_atom
for(var/region in DETSCAN_ACCESS_ORDER())
var/access_in_region = SSid_access.accesses_by_region[region] & user_id.GetAccess()
if(!length(access_in_region))
continue
var/list/access_names = list()
for(var/access_num in access_in_region)
access_names += SSid_access.get_access_desc(access_num)
LAZYADD(log_entry_data[DETSCAN_CATEGORY_ACCESS], region)
LAZYADD(log_entry_data[DETSCAN_CATEGORY_ACCESS][region], english_list(access_names))
// sends it off to be modified by the items
SEND_SIGNAL(scanned_atom, COMSIG_DETECTIVE_SCANNED, user, log_entry_data)
stoplag(3 SECONDS)
log_data += list(log_entry_data)
return TRUE
/proc/get_timestamp()
return time2text(world.time + 432000, ":ss")
/obj/item/detective_scanner/click_alt(mob/living/user)
return clear_logs()
/obj/item/detective_scanner/examine(mob/user)
. = ..()
if(LAZYLEN(log_data) && !scanner_busy)
. += span_notice("Alt-click to clear scanner logs.")
/obj/item/detective_scanner/ui_interact(mob/user, datum/tgui/ui)
ui = SStgui.try_update_ui(user, src, ui)
if(!ui)
ui = new(user, src, "ForensicScanner", "Forensic Scanner")
ui.open()
/obj/item/detective_scanner/ui_data(mob/user)
var/list/data = list()
data["log_data"] = log_data
return data
/obj/item/detective_scanner/ui_act(action, params, datum/tgui/ui)
. = ..()
if(.)
return
switch(action)
if("clear")
clear_logs(ui.user)
ui.send_update()
if("delete")
var/index = params["index"] + 1
if(!log_data[index])
return
if(scanner_busy)
balloon_alert(ui.user, "scanner busy!")
return
log_data.Cut(index, index + 1)
balloon_alert(ui.user, "log deleted")
ui.send_update()
if("print")
if(!LAZYLEN(log_data))
balloon_alert(ui.user, "no logs!")
return
if(scanner_busy)
balloon_alert(ui.user, "scanner busy!")
return
scanner_busy = TRUE
playsound(src, 'sound/machines/printer.ogg', 50)
balloon_alert(ui.user, "printing report...")
addtimer(CALLBACK(src, PROC_REF(safe_print_report)), 3 SECONDS)
/obj/item/detective_scanner/proc/clear_logs(mob/living/user)
if(!LAZYLEN(log_data))
balloon_alert(user, "no logs!")
return CLICK_ACTION_BLOCKING
if(scanner_busy)
balloon_alert(user, "scanner busy!")
return CLICK_ACTION_BLOCKING
balloon_alert(user, "logs cleared")
log_data = list()
return CLICK_ACTION_SUCCESS