From 93aab005dd2c1e2eafb5dce9f0687c4e988cd8dc Mon Sep 17 00:00:00 2001 From: SkyratBot <59378654+SkyratBot@users.noreply.github.com> Date: Fri, 25 Nov 2022 03:42:25 +0100 Subject: [PATCH] [MIRROR] Adds screentips to the customizable food datum [MDB IGNORE] (#17709) * Adds screentips to the customizable food datum (#71444) ## About The Pull Request Straightforward follow up to doing this to processable.dm, adding screentips to a basic cooking thing so that there's never confusion about what is and isn't a valid ingredient for a specific food. Also changes some to_chat stuff into balloon alerts. ![dreamseeker_agcvu4Yew3](https://user-images.githubusercontent.com/116288367/203356066-c6ccba87-72f4-4af0-99c7-f04dd26b8583.png) ![dreamseeker_fJB6K6G3Ze](https://user-images.githubusercontent.com/116288367/203356061-32f24637-159e-4839-8df8-dd9877f677c7.png) ![dreamseeker_2QkSnwZrUu](https://user-images.githubusercontent.com/116288367/203356064-7c81c0d0-0c04-4f56-85f5-cb9f445d1f8c.png) As part of this, customizable food now calculates the valid ingredients in its own variable, which means that if anyone wants to change how valid ingredients work separately from the other parts of how this datum works. I'm unsure of the wording for the tip, i think that having it just be "add" works but it doesn't hurt to start with the possibly unnecessarily specific "add [item you are holding]" ## Why It's Good For The Game Adding in screentips as parts of modules like this is good and I like balloon alerts more than to_chats for really small and fast "you cant do that!" type stuff. ## Changelog :cl: qol: added screentips to customizable food qol: added more balloon alerts to custommizable food /:cl: Co-authored-by: Mothblocks <35135081+Mothblocks@ users.noreply.github.com> * Adds screentips to the customizable food datum Co-authored-by: Sol N <116288367+flowercuco@users.noreply.github.com> Co-authored-by: Mothblocks <35135081+Mothblocks@ users.noreply.github.com> --- .../components/customizable_reagent_holder.dm | 55 ++++++++++++++----- 1 file changed, 42 insertions(+), 13 deletions(-) diff --git a/code/datums/components/customizable_reagent_holder.dm b/code/datums/components/customizable_reagent_holder.dm index ea682da608b..c56b0883b9e 100644 --- a/code/datums/components/customizable_reagent_holder.dm +++ b/code/datums/components/customizable_reagent_holder.dm @@ -22,14 +22,17 @@ var/mutable_appearance/top_overlay ///Type of ingredients to accept, [CUSTOM_INGREDIENT_TYPE_EDIBLE] for example. var/ingredient_type - + /// Adds screentips for all items that call on this proc, defaults to "Add" + var/screentip_verb /datum/component/customizable_reagent_holder/Initialize( atom/replacement, fill_type, ingredient_type = CUSTOM_INGREDIENT_TYPE_EDIBLE, max_ingredients = MAX_ATOM_OVERLAYS - 3, // The cap is >= MAX_ATOM_OVERLAYS so we reserve 2 for top /bottom of item + 1 to stay under cap - list/obj/item/initial_ingredients = null) + list/obj/item/initial_ingredients = null, + screentip_verb = "Add", +) if(!isatom(parent)) return COMPONENT_INCOMPATIBLE var/atom/atom_parent = parent @@ -37,10 +40,13 @@ if (!atom_parent.reagents && !replacement) return COMPONENT_INCOMPATIBLE + atom_parent.flags_1 |= HAS_CONTEXTUAL_SCREENTIPS_1 + src.replacement = replacement src.fill_type = fill_type src.max_ingredients = max_ingredients src.ingredient_type = ingredient_type + src.screentip_verb = screentip_verb if (initial_ingredients) for (var/_ingredient in initial_ingredients) @@ -59,6 +65,7 @@ RegisterSignal(parent, COMSIG_PARENT_ATTACKBY, PROC_REF(customizable_attack)) RegisterSignal(parent, COMSIG_PARENT_EXAMINE, PROC_REF(on_examine)) RegisterSignal(parent, COMSIG_ATOM_PROCESSED, PROC_REF(on_processed)) + RegisterSignal(parent, COMSIG_ATOM_REQUESTING_CONTEXT_FROM_ITEM, PROC_REF(on_requesting_context_from_item)) ADD_TRAIT(parent, TRAIT_CUSTOMIZABLE_REAGENT_HOLDER, REF(src)) @@ -68,6 +75,7 @@ COMSIG_PARENT_ATTACKBY, COMSIG_PARENT_EXAMINE, COMSIG_ATOM_PROCESSED, + COMSIG_ATOM_REQUESTING_CONTEXT_FROM_ITEM, )) REMOVE_TRAIT(parent, TRAIT_CUSTOMIZABLE_REAGENT_HOLDER, REF(src)) @@ -98,26 +106,28 @@ ingredients_listed += "\a [ingredient.name][ending]" examine_list += "It [LAZYLEN(ingredients) ? "contains [ingredients_listed]making a [custom_adjective()]-sized [initial(atom_parent.name)]" : "does not contain any ingredients"]." +//// Proc that checks if an ingredient is valid or not, returning false if it isnt and true if it is. +/datum/component/customizable_reagent_holder/proc/valid_ingredient(obj/ingredient) + if (HAS_TRAIT(ingredient, TRAIT_CUSTOMIZABLE_REAGENT_HOLDER)) + return FALSE + switch (ingredient_type) + if (CUSTOM_INGREDIENT_TYPE_EDIBLE) + return IS_EDIBLE(ingredient) + if (CUSTOM_INGREDIENT_TYPE_DRYABLE) + return HAS_TRAIT(ingredient, TRAIT_DRYABLE) + return TRUE ///Handles when the customizable food is attacked by something. /datum/component/customizable_reagent_holder/proc/customizable_attack(datum/source, obj/ingredient, mob/attacker, silent = FALSE, force = FALSE) SIGNAL_HANDLER - var/valid_ingredient = TRUE - - switch (ingredient_type) - if (CUSTOM_INGREDIENT_TYPE_EDIBLE) - valid_ingredient = IS_EDIBLE(ingredient) - if (CUSTOM_INGREDIENT_TYPE_DRYABLE) - valid_ingredient = HAS_TRAIT(ingredient, TRAIT_DRYABLE) - // only accept valid ingredients - if (!valid_ingredient || HAS_TRAIT(ingredient, TRAIT_CUSTOMIZABLE_REAGENT_HOLDER)) - to_chat(attacker, span_warning("[ingredient] doesn't belong on [parent]!")) + if (!valid_ingredient(ingredient)) + attacker.balloon_alert(attacker, "doesn't go on that!") return if (LAZYLEN(ingredients) >= max_ingredients) - to_chat(attacker, span_warning("[parent] is too full for any more ingredients!")) + attacker.balloon_alert(attacker, "too full!") return COMPONENT_NO_AFTERATTACK var/atom/atom_parent = parent @@ -247,3 +257,22 @@ for (var/r in results) var/atom/result = r result.AddComponent(/datum/component/customizable_reagent_holder, null, fill_type, ingredient_type = ingredient_type, max_ingredients = max_ingredients, initial_ingredients = ingredients) + +/** + * Adds context sensitivy directly to the customizable reagent holder file for screentips + * Arguments: + * * source - refers to item that will display its screentip + * * context - refers to, in this case, an item that can be customized with other reagents or ingrideints + * * held_item - refers to the item in your hand, which is hopefully an ingredient + * * user - refers to user who will see the screentip when the proper context and tool are there + */ +/datum/component/customizable_reagent_holder/proc/on_requesting_context_from_item(datum/source, list/context, obj/item/held_item, mob/user) + SIGNAL_HANDLER + + // only accept valid ingredients + if (!valid_ingredient(held_item)) + return NONE + + context[SCREENTIP_CONTEXT_LMB] = "[screentip_verb] [held_item]" + + return CONTEXTUAL_SCREENTIP_SET