Merge pull request NebulaSS13#4854 from MistakeNot4892/fix/buckets

Generalizing lid states for glass containers.

Author: out-of-phaze

code/datums/supplypacks/nonessent.dm

@@ -15,13 +15,13 @@
 		/obj/item/camera,
 		/obj/item/camera_film = 2,
 		/obj/item/photo_album,
-		/obj/item/chems/glass/paint/red,
-		/obj/item/chems/glass/paint/green,
-		/obj/item/chems/glass/paint/blue,
-		/obj/item/chems/glass/paint/yellow,
-		/obj/item/chems/glass/paint/purple,
-		/obj/item/chems/glass/paint/black,
-		/obj/item/chems/glass/paint/white,
+		/obj/item/chems/glass/bucket/paint/red,
+		/obj/item/chems/glass/bucket/paint/green,
+		/obj/item/chems/glass/bucket/paint/blue,
+		/obj/item/chems/glass/bucket/paint/yellow,
+		/obj/item/chems/glass/bucket/paint/purple,
+		/obj/item/chems/glass/bucket/paint/black,
+		/obj/item/chems/glass/bucket/paint/white,
 		/obj/item/poster,
 		/obj/item/stack/package_wrap/fifty      = 2,
 		/obj/item/stack/package_wrap/gift/fifty = 2

code/game/objects/items/waterskin.dm

@@ -37,7 +37,8 @@
 	update_icon()
 	return TRUE
 
-/obj/item/chems/glass/waterskin/on_update_icon() // TODO: filled/empty sprites
+// TODO: filled/empty sprites
+/obj/item/chems/glass/waterskin/update_overlays()
 	. = ..() // cuts overlays
 	var/image/stopper_overlay = get_stopper_overlay()
 	if(stopper_overlay)

code/game/objects/items/weapons/paint.dm

@@ -1,69 +1,58 @@
-//NEVER USE THIS IT SUX	-PETETHEGOAT
-//THE GOAT WAS RIGHT - RKF
-
-/obj/item/chems/glass/paint
-	desc = "It's a paint bucket."
+/obj/item/chems/glass/bucket/paint
 	name = "paint bucket"
+	desc = "It's a paint bucket."
 	icon = 'icons/obj/items/paint_bucket.dmi'
-	icon_state = "paintbucket"
-	item_state = "paintcan"
 	material = /decl/material/solid/metal/aluminium
 	w_class = ITEM_SIZE_NORMAL
 	amount_per_transfer_from_this = 10
 	possible_transfer_amounts = @"[10,20,30,60]"
 	volume = 60
-	atom_flags = ATOM_FLAG_OPEN_CONTAINER
 	var/pigment
 
-/obj/item/chems/glass/paint/populate_reagents()
+/obj/item/chems/glass/bucket/paint/populate_reagents()
 	var/amt = reagents.maximum_volume
 	if(pigment)
 		amt = round(amt/2)
 		add_to_reagents(pigment, amt)
 	add_to_reagents(/decl/material/liquid/paint, amt)
 
-/obj/item/chems/glass/paint/get_edible_material_amount(mob/eater)
+/obj/item/chems/glass/bucket/paint/get_edible_material_amount(mob/eater)
 	return 0
 
-/obj/item/chems/glass/paint/get_utensil_food_type()
+/obj/item/chems/glass/bucket/paint/get_utensil_food_type()
 	return null
 
-/obj/item/chems/glass/paint/on_update_icon()
-	. = ..()
-	if(reagents?.total_volume)
-		add_overlay(overlay_image('icons/obj/reagentfillings.dmi', "paintbucket", reagents.get_color()))
-
-/obj/item/chems/glass/paint/red
+/obj/item/chems/glass/bucket/paint/red
 	name = "red paint bucket"
 	pigment = /decl/material/liquid/pigment/red
 
-/obj/item/chems/glass/paint/yellow
+/obj/item/chems/glass/bucket/paint/yellow
 	name = "yellow paint bucket"
 	pigment = /decl/material/liquid/pigment/yellow
 
-/obj/item/chems/glass/paint/green
+/obj/item/chems/glass/bucket/paint/green
 	name = "green paint bucket"
 	pigment = /decl/material/liquid/pigment/green
 
-/obj/item/chems/glass/paint/blue
+/obj/item/chems/glass/bucket/paint/blue
 	name = "blue paint bucket"
 	pigment = /decl/material/liquid/pigment/blue
 
-/obj/item/chems/glass/paint/purple
+/obj/item/chems/glass/bucket/paint/purple
 	name = "purple paint bucket"
 	pigment = /decl/material/liquid/pigment/purple
 
-/obj/item/chems/glass/paint/black
+/obj/item/chems/glass/bucket/paint/black
 	name = "black paint bucket"
 	pigment = /decl/material/liquid/pigment/black
 
-/obj/item/chems/glass/paint/white
+/obj/item/chems/glass/bucket/paint/white
 	name = "white paint bucket"
 	pigment = /decl/material/liquid/pigment/white
 
-/obj/item/chems/glass/paint/random
+/obj/item/chems/glass/bucket/paint/random
 	name = "odd paint bucket"
 
-/obj/item/chems/glass/paint/random/Initialize()
+/obj/item/chems/glass/bucket/paint/random/Initialize()
 	pigment = pick(decls_repository.get_decl_paths_of_subtype(/decl/material/liquid/pigment))
 	. = ..()

code/modules/detectivework/tools/rag.dm

@@ -15,6 +15,9 @@
 	var/on_fire = 0
 	var/burn_time = 20 //if the rag burns for too long it turns to ashes
 
+/obj/item/chems/glass/rag/can_lid()
+	return FALSE
+
 /obj/item/chems/glass/rag/get_edible_material_amount(mob/eater)
 	return 0
 

code/modules/paperwork/pen/quill_and_ink.dm

@@ -75,7 +75,7 @@
 	. = ..()
 	add_to_reagents(/decl/material/liquid/pigment/black/ink, rand(starting_volume_low, starting_volume_high))
 
-/obj/item/chems/glass/inkwell/on_update_icon()
+/obj/item/chems/glass/inkwell/update_overlays()
 	. = ..()
 	icon_state = get_world_inventory_state()
 	if(locate(/obj/item/pen/fancy/quill) in src)

code/modules/reagents/reagent_containers/_glass.dm

@@ -64,6 +64,32 @@
 		var/decl/material/drinking = reagents.get_primary_reagent_decl()
 		return drinking ? !drinking.is_unsafe_to_drink(drinker) : FALSE
 
+#ifdef UNIT_TEST
+// Will get generated during atom creation/deletion tests so no need for a distinct unit test.
+var/global/list/lid_check_glass_types = list()
+/obj/item/chems/glass/Initialize()
+	. = ..()
+	if(can_lid() && !global.lid_check_glass_types[type])
+		if(!check_state_in_icon("[icon_state]_lid", icon))
+			log_error("Liddable vessel [type] missing lid state from [icon]!")
+		global.lid_check_glass_types[type] = TRUE
+#endif
+
+/obj/item/chems/glass/on_update_icon()
+	. = ..()
+	update_overlays()
+	compile_overlays()
+
+/obj/item/chems/glass/proc/get_lid_color()
+	return COLOR_WHITE
+
+/obj/item/chems/glass/proc/get_lid_flags()
+	return RESET_COLOR | RESET_ALPHA
+
+/obj/item/chems/glass/proc/update_overlays()
+	if (can_lid() && !ATOM_IS_OPEN_CONTAINER(src))
+		add_overlay(overlay_image(icon, "[icon_state]_lid", get_lid_color(), get_lid_flags()))
+
 /obj/item/chems/glass/attack_self(mob/user)
 
 	if(can_lid() && user.a_intent == I_HELP)

code/modules/reagents/reagent_containers/beaker.dm

@@ -1,4 +1,3 @@
-
 /obj/item/chems/glass/beaker
 	name = "beaker"
 	desc = "A beaker."
@@ -11,6 +10,9 @@
 	presentation_flags = PRESENTATION_FLAG_NAME
 	var/lid_color = COLOR_BEASTY_BROWN
 
+/obj/item/chems/glass/beaker/get_lid_color()
+	return lid_color
+
 /obj/item/chems/glass/beaker/examine(mob/user, distance)
 	. = ..()
 	to_chat(user, " It can hold up to [volume] units.")
@@ -27,9 +29,7 @@
 	. = ..()
 	update_icon()
 
-/obj/item/chems/glass/beaker/on_update_icon()
-	. = ..()
-	cut_overlays()
+/obj/item/chems/glass/beaker/update_overlays()
 
 	if(reagents?.total_volume)
 		var/image/filling = mutable_appearance(icon, "[icon_state]1", reagents.get_color())
@@ -53,8 +53,7 @@
 		shine.alpha = material.reflectiveness * 3
 		add_overlay(shine)
 
-	if (!ATOM_IS_OPEN_CONTAINER(src))
-		add_overlay(mutable_appearance(icon, "[icon_state]_lid", lid_color))
+	. = ..()
 
 	compile_overlays()
 
@@ -108,6 +107,9 @@
 	obj_flags = OBJ_FLAG_HOLLOW | OBJ_FLAG_INSULATED_HANDLE
 	material_alteration = MAT_FLAG_ALTERATION_COLOR | MAT_FLAG_ALTERATION_NAME | MAT_FLAG_ALTERATION_DESC
 
+/obj/item/chems/glass/beaker/kettle/can_lid()
+	return FALSE
+
 /obj/item/chems/glass/beaker/noreact
 	name = "cryostasis beaker"
 	desc = "A cryostasis beaker that allows for chemical storage without reactions."

code/modules/reagents/reagent_containers/bucket.dm

@@ -15,6 +15,13 @@
 	drop_sound = 'sound/foley/donk1.ogg'
 	pickup_sound = 'sound/foley/pickup2.ogg'
 
+/obj/item/chems/glass/bucket/proc/get_handle_overlay()
+	return overlay_image(icon, "[icon_state]-handle", COLOR_WHITE, RESET_COLOR)
+
+/obj/item/chems/glass/bucket/update_overlays()
+	add_overlay(get_handle_overlay())
+	. = ..()
+
 /obj/item/chems/glass/bucket/get_edible_material_amount(mob/eater)
 	return 0
 
@@ -34,11 +41,6 @@
 		return TRUE
 	return ..()
 
-/obj/item/chems/glass/bucket/on_update_icon()
-	. = ..()
-	if (!ATOM_IS_OPEN_CONTAINER(src))
-		add_overlay("lid_[initial(icon_state)]")
-
 /obj/item/chems/glass/bucket/get_reagents_overlay(state_prefix)
 	if(!ATOM_IS_OPEN_CONTAINER(src))
 		return null // no overlay while closed!
@@ -70,9 +72,12 @@
 	overlay.add_overlay(overlay_image(icon, "[overlay.icon_state]_overlay", rivet_material.get_reagent_color(), RESET_COLOR | RESET_ALPHA))
 	return ..()
 
-/obj/item/chems/glass/bucket/wood/on_update_icon()
+/obj/item/chems/glass/bucket/wood/update_overlays()
 	. = ..()
 	add_overlay(overlay_image(icon, "[icon_state]_overlay", rivet_material.get_reagent_color(), RESET_COLOR | RESET_ALPHA))
 
+/obj/item/chems/glass/bucket/wood/get_handle_overlay()
+	return overlay_image(icon, "[icon_state]-handle", rivet_material.get_reagent_color(), RESET_COLOR | RESET_ALPHA)
+
 /obj/item/chems/glass/bucket/wood/can_lid()
-	return FALSE // todo: add lid sprite?
+	return FALSE // todo: add lid sprite?

code/modules/reagents/reagent_containers/glass/bottle.dm

@@ -22,6 +22,9 @@
 	var/lid_color = COLOR_GRAY80
 	var/autolabel = TRUE  		// if set, will add label with the name of the first initial reagent
 
+/obj/item/chems/glass/bottle/get_lid_color()
+	return lid_color
+
 /obj/item/chems/glass/bottle/on_picked_up(mob/user)
 	. = ..()
 	update_icon()
@@ -34,30 +37,20 @@
 	. = ..()
 	update_icon()
 
-/obj/item/chems/glass/bottle/on_update_icon()
-	. = ..()
-	cut_overlays()
-
+/obj/item/chems/glass/bottle/update_overlays()
 	if(reagents?.total_volume)
 		var/percent = round(reagents.total_volume / volume * 100, 25)
 		add_overlay(mutable_appearance(icon, "[icon_state]_filling_[percent]", reagents.get_color()))
-
 	var/image/overglass = mutable_appearance(icon, "[icon_state]_over", color)
 	overglass.alpha = alpha * ((alpha/255) ** 3)
 	add_overlay(overglass)
-
 	if(material.reflectiveness >= MAT_VALUE_SHINY)
 		var/mutable_appearance/shine = mutable_appearance(icon, "[icon_state]_shine", adjust_brightness(color, 20 + material.reflectiveness))
 		shine.alpha = material.reflectiveness * 3
 		add_overlay(shine)
-
 	if(label_text)
 		add_overlay(mutable_appearance(icon, "[icon_state]_label", label_color))
-
-	if (!ATOM_IS_OPEN_CONTAINER(src))
-		add_overlay(mutable_appearance(icon, "[icon_state]_lid", lid_color))
-
-	compile_overlays()
+	. = ..()
 
 /obj/item/chems/glass/bottle/Initialize()
 	. = ..()

code/modules/reagents/reagent_containers/mortar.dm

@@ -15,6 +15,9 @@
 		return
 	return try_grind(using_item, user)
 
+/obj/item/chems/glass/mortar/can_lid()
+	return FALSE
+
 /obj/item/chems/glass/mortar/proc/try_grind(obj/item/using_item, mob/living/user)
 	if(!istype(using_item))
 		return FALSE