Heirloom Audit and Custom(ish) Heirlooms (#823)

Author: MrMelbert

code/__DEFINES/dcs/signals/signals_object.dm

@@ -15,6 +15,11 @@
 /// from /obj/obj_reskin: (mob/user, skin)
 #define COMSIG_OBJ_RESKIN "obj_reskin"
 
+/// from /datum/component/subtype_picker/pick_subtype(): (obj/item/old_item, mob/picker)
+#define COMSIG_ITEM_SUBTYPE_PICKER_SELECTED "item_subtype_picker_selected"
+/// from /datum/component/subtype_picker/pick_subtype(): (obj/item/new_item, mob/picker)
+#define COMSIG_ITEM_SUBTYPE_PICKER_REPLACED "item_subtype_picker_replaced"
+
 // /obj/machinery signals
 
 ///from /obj/machinery/atom_break(damage_flag): (damage_flag)

code/__DEFINES/preferences.dm

@@ -154,8 +154,19 @@
 #define SPRITE_ACCESSORY_NONE "None"
 
 // Loadout
-/// Used to make something not recolorable even if it's capable
-#define DONT_GREYSCALE -1
+/// When equipped, applies a job specific palette to the item. Only applicable to GAGS items.
+#define LOADOUT_FLAG_JOB_GREYSCALING (1<<0)
+/// Prevents GAGS items from being player customizable.
+#define LOADOUT_FLAG_BLOCK_GREYSCALING (1<<1)
+/// Allows the item to be greyscaled by the player, if it's a GAGS item. Automatically set if the item is innately recolorable.
+#define LOADOUT_FLAG_GREYSCALING_ALLOWED (1<<2)
+/// Allows the item to be renamed by the player.
+#define LOADOUT_FLAG_ALLOW_NAMING (1<<3)
+/// Allows the item to be reskinned by the player. Only applicable to items with unique_reskin defined.
+#define LOADOUT_FLAG_ALLOW_RESKIN (1<<4)
+/// The item can be selected as a family heirloom for the family heirloom quirk.
+#define LOADOUT_FLAG_ALLOW_HEIRLOOM (1<<5)
+
 // Loadout item info keys
 // Changing these will break existing loadouts
 /// Tracks GAGS color information
@@ -166,8 +177,28 @@
 #define INFO_RESKIN "reskin"
 /// Handles which layer the item will be on, for accessories
 #define INFO_LAYER "layer"
+/// Is this item an heirloom item
+#define INFO_HEIRLOOM "heirloom"
 
 // Lipstick styles
 #define UPPER_LIP "Upper"
 #define MIDDLE_LIP "Middle"
 #define LOWER_LIP "Lower"
+
+// Job greyscale colors for loadout items
+#define COLOR_JOB_ASSISTANT /obj/item/clothing/under/color/grey::greyscale_colors
+#define COLOR_JOB_BOTANIST "#33cc33"
+#define COLOR_JOB_CARGO_GENERIC "#824b32"
+#define COLOR_JOB_CE "#d0d0d0"
+#define COLOR_JOB_CHEF "#d0d0d0"
+#define COLOR_JOB_CHEMIST "#ff6600"
+#define COLOR_JOB_CLOWN "#ffbeff"
+#define COLOR_JOB_CMO "#009999"
+#define COLOR_JOB_DEFAULT "#303030"
+#define COLOR_JOB_ENGI_GENERIC "#ff6600"
+#define COLOR_JOB_JANITOR /obj/item/clothing/gloves/color/purple::greyscale_colors
+#define COLOR_JOB_LAWYER "#003399"
+#define COLOR_JOB_SCI_GENERIC "#800080"
+#define COLOR_JOB_SEC_GENERIC "#A53228"
+#define COLOR_JOB_MED_GENERIC "#5B97BC"
+#define COLOR_JOB_COMMAND_GENERIC "#3C5A96"

code/datums/components/heirloom.dm

@@ -1,5 +1,6 @@
 /// Heirloom component. For use with the family heirloom quirk, tracks that an item is someone's family heirloom.
 /datum/component/heirloom
+	can_transfer = TRUE
 	/// The mind that actually owns our heirloom.
 	var/datum/mind/owner
 	/// Flavor. The family name of the owner of the heirloom.
@@ -12,7 +13,20 @@
 	owner = new_owner
 	family_name = new_family_name
 
+/datum/component/heirloom/RegisterWithParent()
 	RegisterSignal(parent, COMSIG_ATOM_EXAMINE, PROC_REF(on_examine))
+	RegisterSignal(parent, COMSIG_ITEM_SUBTYPE_PICKER_REPLACED, PROC_REF(transfer_to_new_item))
+
+/datum/component/heirloom/UnregisterFromParent()
+	UnregisterSignal(parent, COMSIG_ATOM_EXAMINE)
+	UnregisterSignal(parent, COMSIG_ITEM_SUBTYPE_PICKER_REPLACED)
+
+/datum/component/heirloom/PostTransfer()
+	if(!isitem(parent))
+		return COMPONENT_INCOMPATIBLE
+	// Moves weakref to our new item
+	var/datum/quirk/item_quirk/family_heirloom/quirk = owner?.current?.get_quirk(/datum/quirk/item_quirk/family_heirloom)
+	quirk?.heirloom = WEAKREF(parent)
 
 /datum/component/heirloom/Destroy(force)
 	owner = null
@@ -38,3 +52,9 @@
 		return
 
 	examine_list += span_notice("It is the [family_name] family heirloom, belonging to [owner].")
+
+/// Transfer the component to a new item when a subtype picker replaces it.
+/datum/component/heirloom/proc/transfer_to_new_item(datum/source, obj/item/new_item, mob/user)
+	SIGNAL_HANDLER
+
+	new_item.TakeComponent(src)

code/datums/components/subtype_picker.dm

@@ -69,11 +69,13 @@
 		return
 
 	var/picked_subtype = name2subtype[name_of_type]
-	on_picked_callback?.Invoke(picked_subtype)
-	picked_subtype = new picked_subtype(picker.drop_location())
+	var/obj/item/picked = new picked_subtype(picker.drop_location())
+	on_picked_callback?.Invoke(picked, picker)
+	SEND_SIGNAL(picked, COMSIG_ITEM_SUBTYPE_PICKER_SELECTED, target, picker)
+	SEND_SIGNAL(target, COMSIG_ITEM_SUBTYPE_PICKER_REPLACED, picked, picker)
 
 	qdel(target)
-	picker.put_in_hands(picked_subtype)
+	picker.put_in_hands(picked)
 
 /**
  * Checks if we are allowed to interact with the radial menu

code/datums/outfit.dm

@@ -24,20 +24,20 @@
 	var/id_trim = null
 
 	/// Type path of item to go in uniform slot
-	var/uniform = null
+	var/obj/item/uniform = null
 
 	/// Type path of item to go in suit slot
-	var/suit = null
+	var/obj/item/suit = null
 
 	/**
 	  * Type path of item to go in suit storage slot
 	  *
 	  * (make sure it's valid for that suit)
 	  */
-	var/suit_store = null
+	var/obj/item/suit_store = null
 
 	/// Type path of item to go in back slot
-	var/back = null
+	var/obj/item/back = null
 
 	/**
 	  * list of items that should go in the backpack of the user
@@ -47,7 +47,7 @@
 	var/list/backpack_contents = null
 
 	/// Type path of item to go in belt slot
-	var/belt = null
+	var/obj/item/belt = null
 
 	/// Type path of item to go in ears slot
 	var/ears = null

code/datums/quirks/negative_quirks/family_heirloom.dm

@@ -1,11 +1,13 @@
 /datum/quirk/item_quirk/family_heirloom
 	name = "Family Heirloom"
-	desc = "You are the current owner of an heirloom, passed down for generations. You have to keep it safe!"
+	desc = "You are the current owner of an heirloom, passed down for generations. \
+		The heirloom is based on your species, job, or one you selected in the loadout. \
+		You have to keep it safe!"
 	icon = FA_ICON_TOOLBOX
 	value = -2
 	medical_record_text = "Patient demonstrates an unnatural attachment to a family heirloom."
 	hardcore_value = 1
-	quirk_flags = QUIRK_HUMAN_ONLY|QUIRK_PROCESSES|QUIRK_MOODLET_BASED
+	quirk_flags = QUIRK_HUMAN_ONLY|QUIRK_PROCESSES|QUIRK_MOODLET_BASED|QUIRK_CHANGES_APPEARANCE
 	/// A weak reference to our heirloom.
 	var/datum/weakref/heirloom
 	mail_goodies = list(/obj/item/storage/briefcase/secure)
@@ -14,31 +16,69 @@
 	var/mob/living/carbon/human/human_holder = quirk_holder
 	var/obj/item/heirloom_type
 
-	// The quirk holder's species - we have a 50% chance, if we have a species with a set heirloom, to choose a species heirloom.
+	var/list/loadout = get_active_loadout(client_source?.prefs)
+	var/loadout_heirloom = FALSE
+	for(var/item_path in loadout)
+		if(loadout[item_path][INFO_HEIRLOOM])
+			heirloom_type = item_path
+			loadout_heirloom = TRUE
+			break
+
+	if(!loadout_heirloom && !GLOB.holy_weapon_type && quirk_holder.mind?.holy_role)
+		for(var/obj/item/nullrod/rod in GLOB.steal_item_handler.objectives_by_path[/obj/item/nullrod])
+			var/turf/rod_turf = get_turf(rod)
+			if(!is_station_level(rod_turf.z))
+				continue
+			heirloom = WEAKREF(rod)
+			LAZYADD(where_items_spawned, span_boldnotice("Your [rod.name] can be found in your office. It is your precious family heirloom, keep it safe!"))
+			return
+
 	var/datum/species/holder_species = human_holder.dna?.species
+	var/datum/job/holder_job = human_holder.mind?.assigned_role
 	if(holder_species && LAZYLEN(holder_species.family_heirlooms) && prob(50))
 		heirloom_type = pick(holder_species.family_heirlooms)
-	else
-		// Our quirk holder's job
-		var/datum/job/holder_job = human_holder.last_mind?.assigned_role
-		if(holder_job && LAZYLEN(holder_job.family_heirlooms))
-			heirloom_type = pick(holder_job.family_heirlooms)
+	else if(holder_job && LAZYLEN(holder_job.family_heirlooms))
+		heirloom_type = pick(holder_job.family_heirlooms)
 
 	// If we didn't find an heirloom somehow, throw them a generic one
-	if(!heirloom_type)
-		heirloom_type = pick(/obj/item/toy/cards/deck, /obj/item/lighter, /obj/item/dice/d20)
+	heirloom_type ||= pick(/obj/item/toy/cards/deck, /obj/item/lighter, /obj/item/dice/d20)
 
-	var/obj/new_heirloom = new heirloom_type(get_turf(human_holder))
+	var/obj/item/new_heirloom = new heirloom_type(get_turf(human_holder))
 	heirloom = WEAKREF(new_heirloom)
 
+	if(loadout_heirloom)
+		var/datum/loadout_item/relevant_item = GLOB.all_loadout_datums[heirloom_type]
+		relevant_item?.on_equip_item(new_heirloom, client_source?.prefs, loadout, human_holder)
+
+	var/list/spawn_locations = list()
+	// specific slots
+	if(new_heirloom.slot_flags & ITEM_SLOT_HEAD)
+		spawn_locations[LOCATION_HEAD] = ITEM_SLOT_HEAD
+	if(new_heirloom.slot_flags & ITEM_SLOT_OCLOTHING)
+		spawn_locations["around your body"] = ITEM_SLOT_OCLOTHING
+	if(new_heirloom.slot_flags & ITEM_SLOT_EYES)
+		spawn_locations[LOCATION_EYES] = ITEM_SLOT_EYES
+	if(new_heirloom.slot_flags & ITEM_SLOT_EARS)
+		spawn_locations["covering your ears"] = ITEM_SLOT_EARS
+	if(new_heirloom.slot_flags & ITEM_SLOT_GLOVES)
+		spawn_locations["covering your hands"] = ITEM_SLOT_GLOVES
+	if(new_heirloom.slot_flags & ITEM_SLOT_NECK)
+		spawn_locations[LOCATION_NECK] = ITEM_SLOT_NECK
+	if(new_heirloom.slot_flags & ITEM_SLOT_MASK)
+		spawn_locations["covering your face"] = ITEM_SLOT_MASK
+	if(new_heirloom.slot_flags & ITEM_SLOT_FEET)
+		spawn_locations["covering your feet"] = ITEM_SLOT_FEET
+	if(new_heirloom.slot_flags & ITEM_SLOT_BELT)
+		spawn_locations["around your waist"] = ITEM_SLOT_BELT
+	// defaults / accessories can just go to backpack, that's fine
+	spawn_locations[LOCATION_LPOCKET] = ITEM_SLOT_LPOCKET
+	spawn_locations[LOCATION_RPOCKET] = ITEM_SLOT_RPOCKET
+	spawn_locations[LOCATION_BACKPACK] = ITEM_SLOT_BACKPACK
+	spawn_locations[LOCATION_HANDS] = ITEM_SLOT_HANDS
+
 	give_item_to_holder(
 		new_heirloom,
-		list(
-			LOCATION_LPOCKET = ITEM_SLOT_LPOCKET,
-			LOCATION_RPOCKET = ITEM_SLOT_RPOCKET,
-			LOCATION_BACKPACK = ITEM_SLOT_BACKPACK,
-			LOCATION_HANDS = ITEM_SLOT_HANDS,
-		),
+		spawn_locations,
 		flavour_text = "This is a precious family heirloom, passed down from generation to generation. Keep it safe!",
 		notify_player = TRUE,
 	)
@@ -47,21 +87,20 @@
 	var/list/names = splittext(quirk_holder.real_name, " ")
 	var/family_name = names[names.len]
 
-	var/obj/family_heirloom = heirloom?.resolve()
-	if(!family_heirloom)
+	var/obj/item/family_heirloom = heirloom?.resolve()
+	if(isnull(family_heirloom))
 		to_chat(quirk_holder, span_boldnotice("A wave of existential dread runs over you as you realize your precious family heirloom is missing. Perhaps the Gods will show mercy on your cursed soul?"))
 		return
 	family_heirloom.AddComponent(/datum/component/heirloom, quirk_holder.mind, family_name)
-
 	return ..()
 
 /datum/quirk/item_quirk/family_heirloom/process()
-	if(quirk_holder.stat == DEAD)
+	if(HAS_TRAIT(quirk_holder, TRAIT_KNOCKEDOUT))
 		return
 
 	var/obj/family_heirloom = heirloom?.resolve()
 
-	if(family_heirloom && (family_heirloom in quirk_holder.get_all_contents()))
+	if(family_heirloom && get(family_heirloom.loc, /mob/living/carbon/human) == quirk_holder)
 		quirk_holder.clear_mood_event("family_heirloom_missing")
 		quirk_holder.add_mood_event("family_heirloom", /datum/mood_event/family_heirloom)
 	else

code/modules/bitrunning/job.dm

@@ -18,7 +18,9 @@
 		/datum/job_department/cargo,
 		)
 
-	family_heirlooms = list(/obj/item/reagent_containers/cup/soda_cans/space_mountain_wind)
+	// family_heirlooms = list(
+	// 	/obj/item/reagent_containers/cup/soda_cans/space_mountain_wind,
+	// )
 
 	mail_goodies = list(
 		/obj/item/food/cornchips = 1,

code/modules/clothing/suits/jobs.dm

@@ -59,6 +59,9 @@
 	. = ..()
 	AddComponent(/datum/component/adjust_fishing_difficulty, -2)
 
+/obj/item/clothing/suit/apron/overalls/grey
+	greyscale_colors = COLOR_JOB_DEFAULT
+	icon_state = "/obj/item/clothing/suit/apron/overalls/grey"
 //Captain
 /obj/item/clothing/suit/jacket/capjacket
 	name = "captain's parade jacket"

code/modules/jobs/job_types/assistant/assistant.dm

@@ -22,7 +22,10 @@ Assistant
 
 	department_for_prefs = /datum/job_department/assistant
 
-	family_heirlooms = list(/obj/item/storage/toolbox/mechanical/old/heirloom, /obj/item/clothing/gloves/cut/heirloom)
+	// family_heirlooms = list(
+	// 	/obj/item/storage/toolbox/mechanical/old/heirloom,
+	// 	/obj/item/clothing/gloves/cut/heirloom,
+	// )
 
 	mail_goodies = list(
 		/obj/effect/spawner/random/food_or_drink/donkpockets = 10,

code/modules/jobs/job_types/atmospheric_technician.dm

@@ -26,7 +26,10 @@
 		/datum/job_department/engineering,
 		)
 
-	family_heirlooms = list(/obj/item/lighter, /obj/item/lighter/greyscale, /obj/item/storage/box/matches)
+	family_heirlooms = list(
+		/obj/item/lighter,
+		/obj/item/lighter/greyscale,
+	)
 
 	mail_goodies = list(
 		/obj/item/rpd_upgrade/unwrench = 30,