diff --git a/code/__defines/materials.dm b/code/__defines/materials.dm index 499c974b475..3dea12295e6 100644 --- a/code/__defines/materials.dm +++ b/code/__defines/materials.dm @@ -61,3 +61,15 @@ #define DEFAULT_WALL_MATERIAL "steel" #define TABLE_BRITTLE_MATERIAL_MULTIPLIER 4 // Amount table damage is multiplied by if it is made of a brittle material (e.g. glass) + +//Material Container Flags. +///If the container shows the amount of contained materials on examine. +#define MATCONTAINER_EXAMINE (1<<0) +///If the container cannot have materials inserted through attackby(). +#define MATCONTAINER_NO_INSERT (1<<1) +///if the user can insert mats into the container despite the intent. +#define MATCONTAINER_ANY_INTENT (1<<2) +///if the user won't receive a warning when attacking the container with an unallowed item. +#define MATCONTAINER_SILENT (1<<3) + +#define GET_MATERIAL_REF(arguments...) _GetMaterialRef(list(##arguments)) \ No newline at end of file diff --git a/code/_global_vars/typecache.dm b/code/_global_vars/typecache.dm new file mode 100644 index 00000000000..2fdb1bd579a --- /dev/null +++ b/code/_global_vars/typecache.dm @@ -0,0 +1,6 @@ +//please store common type caches here. +//type caches should only be stored here if used in mutiple places or likely to be used in mutiple places. + +//Note: typecache can only replace istype if you know for sure the thing is at least a datum. + +GLOBAL_LIST_INIT(typecache_stack, typecacheof(/obj/item/stack)) \ No newline at end of file diff --git a/code/datums/components/material_container.dm b/code/datums/components/material_container.dm new file mode 100644 index 00000000000..aaa3144598a --- /dev/null +++ b/code/datums/components/material_container.dm @@ -0,0 +1,438 @@ +/*! + This datum should be used for handling mineral contents of machines and whatever else is supposed to hold minerals and make use of them. + + Variables: + amount - raw amount of the mineral this container is holding, calculated by the defined value SHEET_MATERIAL_AMOUNT=2000. + max_amount - max raw amount of mineral this container can hold. + stack_type - type of the mineral sheet the container handles, used for output. + parent - object that this container is being used by, used for output. + MAX_STACK_SIZE - size of a stack of mineral sheets. Constant. +*/ + +/datum/component/material_container + /// The total amount of materials this material container contains + var/total_amount = 0 + /// The maximum amount of materials this material container can contain + var/max_amount + /// Map of material ref -> amount + var/list/materials //Map of key = material ref | Value = amount + /// The list of materials that this material container can accept + var/list/allowed_materials + /// The typecache of things that this material container can accept + var/list/allowed_item_typecache + /// The last main material that was inserted into this container + var/last_inserted_id + /// Whether or not this material container allows specific amounts from sheets to be inserted + var/precise_insertion = FALSE + /// A callback for checking wheter we can insert a material into this container + var/datum/callback/insertion_check + /// A callback invoked before materials are inserted into this container + var/datum/callback/precondition + /// A callback invoked after materials are inserted into this container + var/datum/callback/after_insert + /// The material container flags. See __DEFINES/materials.dm. + var/mat_container_flags + +/// Sets up the proper signals and fills the list of materials with the appropriate references. +/datum/component/material_container/Initialize(list/init_mats, max_amt = 0, _mat_container_flags=NONE, list/allowed_mats=init_mats, list/allowed_items, datum/callback/_insertion_check, datum/callback/_precondition, datum/callback/_after_insert) + if(!isatom(parent)) + return COMPONENT_INCOMPATIBLE + + materials = list() + max_amount = max(0, max_amt) + mat_container_flags = _mat_container_flags + + allowed_materials = allowed_mats || list() + if(allowed_items) + if(ispath(allowed_items) && allowed_items == /obj/item/stack) + allowed_item_typecache = GLOB.typecache_stack + else + allowed_item_typecache = typecacheof(allowed_items) + + insertion_check = _insertion_check + precondition = _precondition + after_insert = _after_insert + + for(var/mat in init_mats) //Make the assoc list material reference -> amount + var/mat_ref = GET_MATERIAL_REF(mat) + if(isnull(mat_ref)) + continue + var/mat_amt = init_mats[mat] + if(isnull(mat_amt)) + mat_amt = 0 + materials[mat_ref] += mat_amt + +/datum/component/material_container/Destroy(force, silent) + materials = null + allowed_materials = null + if(insertion_check) + QDEL_NULL(insertion_check) + if(precondition) + QDEL_NULL(precondition) + if(after_insert) + QDEL_NULL(after_insert) + return ..() + + +/datum/component/material_container/RegisterWithParent() + . = ..() + + if(!(mat_container_flags & MATCONTAINER_NO_INSERT)) + RegisterSignal(parent, COMSIG_PARENT_ATTACKBY, .proc/on_attackby) + if(mat_container_flags & MATCONTAINER_EXAMINE) + RegisterSignal(parent, COMSIG_PARENT_EXAMINE, .proc/on_examine) + + +/datum/component/material_container/vv_edit_var(var_name, var_value) + var/old_flags = mat_container_flags + . = ..() + if(var_name == NAMEOF(src, mat_container_flags) && parent) + if(!(old_flags & MATCONTAINER_EXAMINE) && mat_container_flags & MATCONTAINER_EXAMINE) + RegisterSignal(parent, COMSIG_PARENT_EXAMINE, .proc/on_examine) + else if(old_flags & MATCONTAINER_EXAMINE && !(mat_container_flags & MATCONTAINER_EXAMINE)) + UnregisterSignal(parent, COMSIG_PARENT_EXAMINE) + + if(old_flags & MATCONTAINER_NO_INSERT && !(mat_container_flags & MATCONTAINER_NO_INSERT)) + RegisterSignal(parent, COMSIG_PARENT_ATTACKBY, .proc/on_attackby) + else if(!(old_flags & MATCONTAINER_NO_INSERT) && mat_container_flags & MATCONTAINER_NO_INSERT) + UnregisterSignal(parent, COMSIG_PARENT_ATTACKBY) + + +/datum/component/material_container/proc/on_examine(datum/source, mob/user, list/examine_texts) + SIGNAL_HANDLER + + for(var/I in materials) + var/datum/material/M = I + var/amt = materials[I] + if(amt) + examine_texts += "It has [amt] units of [lowertext(M.name)] stored." + +/// Proc that allows players to fill the parent with mats +/datum/component/material_container/proc/on_attackby(datum/source, obj/item/I, mob/living/user) + SIGNAL_HANDLER + + var/list/tc = allowed_item_typecache + if(!(mat_container_flags & MATCONTAINER_ANY_INTENT) && user.a_intent != I_HELP) + return + // if(I.item_flags & ABSTRACT) + // return + if(/*(I.flags_1 & HOLOGRAM_1) || (I.item_flags & NO_MAT_REDEMPTION) ||*/ (tc && !is_type_in_typecache(I, tc))) + if(!(mat_container_flags & MATCONTAINER_SILENT)) + to_chat(user, "[parent] won't accept [I]!") + return + . = COMPONENT_NO_AFTERATTACK + var/datum/callback/pc = precondition + if(pc && !pc.Invoke(user)) + return + var/material_amount = get_item_material_amount(I, mat_container_flags) + if(!material_amount) + to_chat(user, "[I] does not contain sufficient materials to be accepted by [parent].") + return + if(!has_space(material_amount)) + to_chat(user, "[parent] is full. Please remove materials from [parent] in order to insert more.") + return + user_insert(I, user, mat_container_flags) + +/// Proc used for when player inserts materials +/datum/component/material_container/proc/user_insert(obj/item/I, mob/living/user, breakdown_flags = mat_container_flags) + set waitfor = FALSE + var/requested_amount + var/active_held = user.get_active_hand() // differs from I when using TK + if(istype(I, /obj/item/stack) && precise_insertion) + var/atom/current_parent = parent + var/obj/item/stack/S = I + requested_amount = input(user, "How much do you want to insert?", "Inserting [S.singular_name]s") as num|null + if(isnull(requested_amount) || (requested_amount <= 0)) + return + if(QDELETED(I) || QDELETED(user) || QDELETED(src) || parent != current_parent || user.physical_can_use_tgui_topic(current_parent) < STATUS_INTERACTIVE || user.get_active_hand() != active_held) + return + if(!user.unEquip(I)) + to_chat(user, "[I] is stuck to you and cannot be placed into [parent].") + return + var/inserted = insert_item(I, stack_amt = requested_amount, breakdown_flags= mat_container_flags) + if(inserted) + to_chat(user, "You insert a material total of [inserted] into [parent].") + qdel(I) + if(after_insert) + after_insert.Invoke(I, last_inserted_id, inserted) + else if(I == active_held) + user.put_in_active_hand(I) + +/// Proc specifically for inserting items, returns the amount of materials entered. +/datum/component/material_container/proc/insert_item(obj/item/I, multiplier = 1, stack_amt, breakdown_flags = mat_container_flags) + if(QDELETED(I)) + return FALSE + + multiplier = CEILING(multiplier, 0.01) + + var/material_amount = get_item_material_amount(I, breakdown_flags) + if(!material_amount || !has_space(material_amount)) + return FALSE + + last_inserted_id = insert_item_materials(I, multiplier, breakdown_flags) + return material_amount + +/** + * Inserts the relevant materials from an item into this material container. + * + * Arguments: + * - [source][/obj/item]: The source of the materials we are inserting. + * - multiplier: The multiplier for the materials being inserted. + * - breakdown_flags: The breakdown bitflags that will be used to retrieve the materials from the source + */ +/datum/component/material_container/proc/insert_item_materials(obj/item/source, multiplier = 1, breakdown_flags = mat_container_flags) + var/primary_mat + var/max_mat_value = 0 + var/list/item_materials = source.get_material_composition(breakdown_flags) + for(var/MAT in item_materials) + if(!can_hold_material(MAT)) + continue + materials[MAT] += item_materials[MAT] * multiplier + total_amount += item_materials[MAT] * multiplier + if(item_materials[MAT] > max_mat_value) + max_mat_value = item_materials[MAT] + primary_mat = MAT + + return primary_mat + +/** + * The default check for whether we can add materials to this material container. + * + * Arguments: + * - [mat][/atom/material]: The material we are checking for insertability. + */ +/datum/component/material_container/proc/can_hold_material(datum/material/mat) + if(mat in allowed_materials) + return TRUE + if(istype(mat) && ((mat.name in allowed_materials) || (mat.type in allowed_materials))) + allowed_materials += mat // This could get messy with passing lists by ref... but if you're doing that the list expansion is probably being taken care of elsewhere anyway... + return TRUE + if(insertion_check?.Invoke(mat)) + allowed_materials += mat + return TRUE + return FALSE + +/// For inserting an amount of material +/datum/component/material_container/proc/insert_amount_mat(amt, datum/material/mat) + if(amt <= 0 || !has_space(amt)) + return 0 + + var/total_amount_saved = total_amount + if(mat) + if(!istype(mat)) + mat = GET_MATERIAL_REF(mat) + materials[mat] += amt + else + var/num_materials = length(materials) + if(!num_materials) + return 0 + + amt /= num_materials + for(var/i in materials) + materials[i] += amt + total_amount += amt + return (total_amount - total_amount_saved) + +/// Uses an amount of a specific material, effectively removing it. +/datum/component/material_container/proc/use_amount_mat(amt, datum/material/mat) + if(!istype(mat)) + mat = GET_MATERIAL_REF(mat) + + if(!mat) + return 0 + var/amount = materials[mat] + if(amount < amt) + return 0 + + materials[mat] -= amt + total_amount -= amt + return amt + +/// Proc for transfering materials to another container. +/datum/component/material_container/proc/transer_amt_to(datum/component/material_container/T, amt, datum/material/mat) + if(!istype(mat)) + mat = GET_MATERIAL_REF(mat) + if((amt==0)||(!T)||(!mat)) + return FALSE + if(amt<0) + return T.transer_amt_to(src, -amt, mat) + var/tr = min(amt, materials[mat], T.can_insert_amount_mat(amt, mat)) + if(tr) + use_amount_mat(tr, mat) + T.insert_amount_mat(tr, mat) + return tr + return FALSE + +/// Proc for checking if there is room in the component, returning the amount or else the amount lacking. +/datum/component/material_container/proc/can_insert_amount_mat(amt, datum/material/mat) + if(!amt || !mat) + return 0 + + if((total_amount + amt) <= max_amount) + return amt + else + return (max_amount - total_amount) + + +/// For consuming a dictionary of materials. mats is the map of materials to use and the corresponding amounts, example: list(M/datum/material/glass =100, datum/material/iron=200) +/datum/component/material_container/proc/use_materials(list/mats, multiplier=1) + if(!mats || !length(mats)) + return FALSE + + var/list/mats_to_remove = list() //Assoc list MAT | AMOUNT + + for(var/x in mats) //Loop through all required materials + var/datum/material/req_mat = x + if(!istype(req_mat)) + req_mat = GET_MATERIAL_REF(req_mat) //Get the ref if necesary + if(!materials[req_mat]) //Do we have the resource? + return FALSE //Can't afford it + var/amount_required = mats[x] * multiplier + if(!(materials[req_mat] >= amount_required)) // do we have enough of the resource? + return FALSE //Can't afford it + mats_to_remove[req_mat] += amount_required //Add it to the assoc list of things to remove + continue + + var/total_amount_save = total_amount + + for(var/i in mats_to_remove) + total_amount_save -= use_amount_mat(mats_to_remove[i], i) + + return total_amount_save - total_amount + +/// For spawning mineral sheets at a specific location. Used by machines to output sheets. +/datum/component/material_container/proc/retrieve_sheets(sheet_amt, datum/material/M, atom/target = null) + if(!M.stack_type) + return 0 //Add greyscale sheet handling here later + if(sheet_amt <= 0) + return 0 + + if(!target) + var/atom/parent_atom = parent + target = parent_atom.drop_location() + if(materials[M] < (sheet_amt * SHEET_MATERIAL_AMOUNT)) + sheet_amt = round(materials[M] / SHEET_MATERIAL_AMOUNT) + + var/obj/item/stack/S = M.stack_type + var/max_stack_size = initial(S.max_amount) + + var/count = 0 + while(sheet_amt > max_stack_size) + new M.stack_type(target, max_stack_size, null, list((M) = SHEET_MATERIAL_AMOUNT)) + count += max_stack_size + use_amount_mat(sheet_amt * SHEET_MATERIAL_AMOUNT, M) + sheet_amt -= max_stack_size + if(sheet_amt >= 1) + new M.stack_type(target, sheet_amt, null, list((M) = SHEET_MATERIAL_AMOUNT)) + count += sheet_amt + use_amount_mat(sheet_amt * SHEET_MATERIAL_AMOUNT, M) + return count + + +/// Proc to get all the materials and dump them as sheets +/datum/component/material_container/proc/retrieve_all(target = null) + var/result = 0 + for(var/MAT in materials) + var/amount = materials[MAT] + result += retrieve_sheets(amount2sheet(amount), MAT, target) + return result + +/// Proc that returns TRUE if the container has space +/datum/component/material_container/proc/has_space(amt = 0) + return (total_amount + amt) <= max_amount + +/// Checks if its possible to afford a certain amount of materials. Takes a dictionary of materials. +/datum/component/material_container/proc/has_materials(list/mats, multiplier=1) + if(!mats || !mats.len) + return FALSE + + for(var/x in mats) //Loop through all required materials + var/datum/material/req_mat = x + if(!istype(req_mat)) + if(ispath(req_mat)) //Is this an actual material, or is it a category? + req_mat = GET_MATERIAL_REF(req_mat) //Get the ref + + // else // Its a category. (For example MAT_CATEGORY_RIGID) + // if(!has_enough_of_category(req_mat, mats[x], multiplier)) //Do we have enough of this category? + // return FALSE + // else + // continue + + if(!has_enough_of_material(req_mat, mats[x], multiplier))//Not a category, so just check the normal way + return FALSE + + return TRUE + +/// Returns all the categories in a recipe. +/datum/component/material_container/proc/get_categories(list/mats) + var/list/categories = list() + for(var/x in mats) //Loop through all required materials + if(!istext(x)) //This means its not a category + continue + categories += x + return categories + +/// Returns TRUE if you have enough of the specified material. +/datum/component/material_container/proc/has_enough_of_material(datum/material/req_mat, amount, multiplier=1) + if(!materials[req_mat]) //Do we have the resource? + return FALSE //Can't afford it + var/amount_required = amount * multiplier + if(materials[req_mat] >= amount_required) // do we have enough of the resource? + return TRUE + return FALSE //Can't afford it + +/// Returns TRUE if you have enough of a specified material category (Which could be multiple materials) +// /datum/component/material_container/proc/has_enough_of_category(category, amount, multiplier=1) +// for(var/i in SSmaterials.materials_by_category[category]) +// var/datum/material/mat = i +// if(materials[mat] >= amount) //we have enough +// return TRUE +// return FALSE + +/// Turns a material amount into the amount of sheets it should output +/datum/component/material_container/proc/amount2sheet(amt) + if(amt >= SHEET_MATERIAL_AMOUNT) + return round(amt / SHEET_MATERIAL_AMOUNT) + return FALSE + +/// Turns an amount of sheets into the amount of material amount it should output +/datum/component/material_container/proc/sheet2amount(sheet_amt) + if(sheet_amt > 0) + return sheet_amt * SHEET_MATERIAL_AMOUNT + return FALSE + + +///returns the amount of material relevant to this container; if this container does not support glass, any glass in 'I' will not be taken into account +/datum/component/material_container/proc/get_item_material_amount(obj/item/I, breakdown_flags = mat_container_flags) + if(!istype(I) || !I.matter) + return 0 + var/material_amount = 0 + var/list/item_materials = I.get_material_composition(breakdown_flags) + for(var/MAT in item_materials) + if(!can_hold_material(MAT)) + continue + material_amount += item_materials[MAT] + return material_amount + +/// Returns the amount of a specific material in this container. +/datum/component/material_container/proc/get_material_amount(datum/material/mat) + if(!istype(mat)) + mat = GET_MATERIAL_REF(mat) + return materials[mat] + +/// List format is list(material_name = list(amount = ..., ref = ..., etc.)) +/datum/component/material_container/tgui_data(mob/user) + var/list/data = list() + + for(var/datum/material/material as anything in materials) + var/amount = materials[material] + + data += list(list( + "name" = material.name, + "ref" = REF(material), + "amount" = amount, + "sheets" = round(amount / SHEET_MATERIAL_AMOUNT), + "removable" = amount >= SHEET_MATERIAL_AMOUNT, + )) + + return data diff --git a/code/modules/materials/materials/_materials.dm b/code/modules/materials/materials/_materials.dm index 4ff29932b0c..75aef7e1bc2 100644 --- a/code/modules/materials/materials/_materials.dm +++ b/code/modules/materials/materials/_materials.dm @@ -49,6 +49,24 @@ var/list/name_to_material if(material) return material.name + +/** + * Returns the material composition of the atom. + * + * Used when recycling items, specifically to turn alloys back into their component mats. + * + * Exists because I'd need to add a way to un-alloy alloys or otherwise deal + * with people converting the entire stations material supply into alloys. + * + * Arguments: + * - flags: A set of flags determining how exactly the materials are broken down. (unused) + */ +/obj/proc/get_material_composition(breakdown_flags=NONE) + . = list() + for(var/mat in matter) + var/datum/material/M = GET_MATERIAL_REF(mat) + .[M] = matter[mat] + // Builds the datum list above. /proc/populate_material_list(force_remake=0) if(name_to_material && !force_remake) return // Already set up! @@ -72,6 +90,73 @@ var/list/name_to_material return material.display_name return null +/** Fetches a cached material singleton when passed sufficient arguments. + * + * Arguments: + * - [arguments][/list]: The list of arguments used to fetch the material ref. + * - The first element is a material datum, text string, or material type. + * - [Material datums][/datum/material] are assumed to be references to the cached datum and are returned + * - Text is assumed to be the text ID of a material and the corresponding material is fetched from the cache + * - A material type is checked for bespokeness: + * - If the material type is not bespoke the type is assumed to be the id for a material and the corresponding material is loaded from the cache. + * - If the material type is bespoke a text ID is generated from the arguments list and used to load a material datum from the cache. + * - The following elements are used to generate bespoke IDs + */ +/proc/_GetMaterialRef(list/arguments) + if(!name_to_material) + populate_material_list() + + var/datum/material/key = arguments[1] + if(istype(key)) + return key // we want to convert anything we're given to a material + + if(istext(key)) // text ID + . = name_to_material[key] + if(!.) + warning("Attempted to fetch material ref with invalid text id '[key]'") + return + + if(!ispath(key, /datum/material)) + CRASH("Attempted to fetch material ref with invalid key [key]") + + key = GetIdFromArguments(arguments) + . = name_to_material[key] + if(!.) + warning("Attempted to fetch nonexistent material with key [key]") + +/** I'm not going to lie, this was swiped from [SSdcs][/datum/controller/subsystem/processing/dcs]. + * Credit does to ninjanomnom + * + * Generates an id for bespoke ~~elements~~ materials when given the argument list + * Generating the id here is a bit complex because we need to support named arguments + * Named arguments can appear in any order and we need them to appear after ordered arguments + * We assume that no one will pass in a named argument with a value of null + **/ +/proc/GetIdFromArguments(list/arguments) + var/datum/material/mattype = arguments[1] + var/list/fullid = list("[initial(mattype.name) || mattype]") + var/list/named_arguments = list() + for(var/i in 2 to length(arguments)) + var/key = arguments[i] + var/value + if(istext(key)) + value = arguments[key] + if(!(istext(key) || isnum(key))) + key = REF(key) + key = "[key]" // Key is stringified so numbers dont break things + if(!isnull(value)) + if(!(istext(value) || isnum(value))) + value = REF(value) + named_arguments["[key]"] = value + else + fullid += "[key]" + + if(length(named_arguments)) + named_arguments = sortList(named_arguments) + fullid += named_arguments + return list2params(fullid) + + // Material definition and procs follow. /datum/material var/name // Unique name for use in indexing the list. @@ -131,7 +216,7 @@ var/list/name_to_material var/tableslam_noise = 'sound/weapons/tablehit1.ogg' // Noise made when a simple door made of this material opens or closes. var/dooropen_noise = 'sound/effects/stonedoor_openclose.ogg' - // Path to resulting stacktype. Todo remove need for this. + // Path to resulting stacktype. var/stack_type // Wallrot crumble message. var/rotting_touch_message = "crumbles under your touch" diff --git a/vorestation.dme b/vorestation.dme index e9f8b47c53c..f23ca26a832 100644 --- a/vorestation.dme +++ b/vorestation.dme @@ -349,6 +349,7 @@ #include "code\datums\autolathe\tools.dm" #include "code\datums\autolathe\tools_vr.dm" #include "code\datums\components\_component.dm" +#include "code\datums\components\material_container.dm" #include "code\datums\components\resize_guard.dm" #include "code\datums\components\crafting\crafting.dm" #include "code\datums\components\crafting\crafting_external.dm"