From 819d9d90822036034df32ae4e7a71c18330637ca Mon Sep 17 00:00:00 2001
From: texan-down-under <73374039+etherware-novice@users.noreply.github.com>
Date: Mon, 21 Nov 2022 01:03:51 -0600
Subject: [PATCH] Refactors some of the dice code to be more general (#70849)

## About The Pull Request
Refactors the dice code some, namely adding 3 things to it:
Making the comments affect all dice and not just d20's
Adding an option to put custom comments on custom faces
Generalizing manipulating the result for the d00, so other dice can
potentially add their own

## Why It's Good For The Game
Makes the dice code a bit more modular, and removing the hardcoding for
the d20 and d00 will help make the dice feel more organic


Co-authored-by: etherware-novice <candy@notarealaddr.com>
---
 code/game/objects/items/dice.dm | 28 ++++++++++++++++++++++------
 1 file changed, 22 insertions(+), 6 deletions(-)

diff --git a/code/game/objects/items/dice.dm b/code/game/objects/items/dice.dm
index 58b2dc38e9a..e6200d78f9f 100644
--- a/code/game/objects/items/dice.dm
+++ b/code/game/objects/items/dice.dm
@@ -1,3 +1,7 @@
+// don't produce a comment if the dice has less than this many sides
+// so you don't have d1's and d4's constantly producing comments
+#define MIN_SIDES_ALERT 5
+
 ///holding bag for dice
 /obj/item/storage/dice
 	name = "bag of dice"
@@ -136,7 +140,7 @@
 	desc = "A die with six sides but only three results. Is this a plus or a minus? Your mind is drawing a blank..."
 	sides = 3 //shhh
 	icon_state = "fudge"
-	special_faces = list("minus","blank","plus")
+	special_faces = list("minus","blank" = "You aren't sure how to feel.","plus")
 
 /obj/item/dice/d8
 	name = "d8"
@@ -156,6 +160,9 @@
 	icon_state = "d00"
 	sides = 10
 
+/obj/item/dice/d00/manipulate_result(original)
+	return (original - 1)*10  // 10, 20, 30, etc
+
 /obj/item/dice/d12
 	name = "d12"
 	desc = "A die with twelve sides. There's an air of neglect about it."
@@ -222,15 +229,18 @@
 
 	var/fake_result = roll(sides)//Daredevil isn't as good as he used to be
 	var/comment = ""
-	if(sides == 20 && result == 20)
-		comment = "NAT 20!"
-	else if(sides == 20 && result == 1)
+	if(sides > MIN_SIDES_ALERT && result == 1)  // less comment spam
 		comment = "Ouch, bad luck."
+	if(sides == 20 && result == 20)
+		comment = "NAT 20!"  // maint wanted this hardcoded to nat20 don't blame me
 	update_appearance()
-	if(initial(icon_state) == "d00")
-		result = (result - 1)*10
+	result = manipulate_result(result)
 	if(special_faces.len == sides)
+		comment = ""  // its not a number
 		result = special_faces[result]
+		if(!ISINTEGER(result))
+			comment = special_faces[result]  // should be a str now
+
 	if(user != null) //Dice was rolled in someone's hand
 		user.visible_message(span_notice("[user] throws [src]. It lands on [result]. [comment]"), \
 			span_notice("You throw [src]. It lands on [result]. [comment]"), \
@@ -249,6 +259,10 @@
 
 	return ..() | COMPONENT_MICROWAVE_SUCCESS
 
+/// A proc to modify the displayed result. (Does not affect what the icon_state is passed.)
+/obj/item/dice/proc/manipulate_result(original)
+	return original
+
 // Die of fate stuff
 /obj/item/dice/d20/fate
 	name = "\improper Die of Fate"
@@ -495,3 +509,5 @@
 		asoundout = 'sound/magic/wand_teleport.ogg',
 		channel = TELEPORT_CHANNEL_MAGIC,
 	)
+
+#undef MIN_SIDES_ALERT