Files
Bubberstation/code/datums/elements/weapon_description.dm
John Willard 2e4d70afe5 Updates href uses for 516 (#88699)
## About The Pull Request

Was just scrolling through the Paradise github since they seem to have
more work done for 516 to see if there's anything I can port over, found
this and thought why not.

Ports parts of https://github.com/ParadiseSS13/Paradise/pull/25105
Specifically, updaing all hrefs to use the internal ``byond://``, and
adding it to grep.

## Why It's Good For The Game

More work towards 516.

## Changelog

Nothing player-facing.
2024-12-24 11:42:20 -08:00

125 lines
4.7 KiB
Plaintext

/**
*
* The purpose of this element is to widely provide the ability to examine an object and determine its stats, with the ability to add
* additional notes or information based on type or other factors
*
*/
/datum/element/weapon_description
element_flags = ELEMENT_BESPOKE
argument_hash_start_idx = 2
// Additional proc to be run for specific object types
var/attached_proc
/datum/element/weapon_description/Attach(datum/target, attached_proc)
. = ..()
if(!isitem(target)) // Do not attach this to anything that isn't an item
return ELEMENT_INCOMPATIBLE
RegisterSignal(target, COMSIG_ATOM_EXAMINE, PROC_REF(warning_label))
RegisterSignal(target, COMSIG_TOPIC, PROC_REF(topic_handler))
// Don't perform the assignment if there is nothing to assign, or if we already have something for this bespoke element
if(attached_proc && !src.attached_proc)
src.attached_proc = attached_proc
/datum/element/weapon_description/Detach(datum/target)
. = ..()
UnregisterSignal(target, list(COMSIG_ATOM_EXAMINE, COMSIG_TOPIC))
/**
*
* This proc is called when the user examines an object with the associated element. This produces a hyperlinked
* text line provided that the given item meets the weapon-determining criteria (Sufficient force or notes)
*
* Arguments:
* * source - Object being examined, cast into an item variable
* * user - Unused
* * examine_texts - The output text list of the original examine function
*/
/datum/element/weapon_description/proc/warning_label(obj/item/item, mob/user, list/examine_texts)
SIGNAL_HANDLER
if(item.force >= 5 || item.throwforce >= 5 || item.override_notes || item.offensive_notes || attached_proc) /// Only show this tag for items that could feasibly be weapons, shields, or those that have special notes
examine_texts += span_notice("<a href='byond://?src=[REF(item)];examine=1'>See combat information.</a>")
/**
*
* Details the stats of the examined weapon
*
* This function is called when the user clicks the hyperlink provided by
* warning_label(). It calls build_label_text() and outputs its return value to the user
*
* Arguments:
* * source - Object being examined, sent to build_label_text()
* * href-list - List provided by the href of input values, used to know what hyperlinked action is being attempted
*/
/datum/element/weapon_description/proc/topic_handler(atom/source, user, href_list)
SIGNAL_HANDLER
if(href_list["examine"])
to_chat(user, span_notice(boxed_message("[build_label_text(source)]")))
/**
*
* Compiles a warning label detailing various statistics of the examined weapon
*
* This function is called by the "examine" function of Topic(), and compiles a number of relevant
* weapon stats into a message that is then shown to the user
* Arguments:
* * source - The object whose stats are being examined
*/
/datum/element/weapon_description/proc/build_label_text(obj/item/source)
var/list/readout = list() // Readout is used to store the text block output to the user so it all can be sent in one message
// Doesn't show the base notes for items that have the override notes variable set to true
if(!source.override_notes)
if (source.get_sharpness() & SHARP_EDGED)
readout += "It's sharp and could cause bleeding wounds."
if (source.get_sharpness() & SHARP_POINTY)
readout += "It's pointy and could cause piercing wounds."
// Make sure not to divide by 0 on accident
if(source.force > 0)
readout += "It takes about [span_warning("[HITS_TO_CRIT(source.force)] melee hit\s")] to take down an enemy."
else
readout += "It does not deal noticeable melee damage."
if(source.throwforce > 0)
readout += "It takes about [span_warning("[HITS_TO_CRIT(source.throwforce)] throwing hit\s")] to take down an enemy."
else
readout += "It does not deal noticeable throwing damage."
if(source.armour_penetration > 0 || source.block_chance > 0)
readout += "It has [span_warning("[weapon_tag_convert(source.armour_penetration)]")] armor-piercing capability and [span_warning("[weapon_tag_convert(source.block_chance)]")] blocking capability."
// Custom manual notes
if(source.offensive_notes)
readout += source.offensive_notes
// Check if we have an additional proc, if so, add it to the readout
if(attached_proc)
readout += call(source, attached_proc)()
// Finally bringing the fields together
return readout.Join("\n")
/**
*
* Converts percentile based stats to an adjective appropriate for the
* examined warning label
*
* Arguments:
* * tag_val: The value of the item to be added to the tag
*/
/datum/element/weapon_description/proc/weapon_tag_convert(tag_val)
switch(tag_val)
if(0)
return "NO"
if(1 to 25)
return "LITTLE"
if(26 to 50)
return "AVERAGE"
if(51 to 75)
return "ABOVE-AVERAGE"
if(76 to INFINITY)
return "EXCELLENT"
else
return "WEIRD"