mirror of
https://github.com/Bubberstation/Bubberstation.git
synced 2025-12-11 10:11:09 +00:00
375a20e49b
Converts most spans into span procs. Mostly used regex for this and sorted out any compile time errors afterwards so there could be some bugs. Was initially going to do defines, but ninja said to make it into a proc, and if there's any overhead, they can easily be changed to defines. Makes it easier to control the formatting and prevents typos when creating spans as it'll runtime if you misspell instead of silently failing. Reduces the code you need to write when writing spans, as you don't need to close the span as that's automatically handled by the proc. (Note from Lemon: This should be converted to defines once we update the minimum version to 514. Didn't do it now because byond pain and such)
92 lines
3.6 KiB
Plaintext
92 lines
3.6 KiB
Plaintext
/**
|
|
The label component.
|
|
|
|
This component is used to manage labels applied by the hand labeler.
|
|
|
|
Atoms can only have one instance of this component, and therefore only one label at a time.
|
|
This is to avoid having names like "Backpack (label1) (label2) (label3)". This is annoying and abnoxious to read.
|
|
|
|
When a player clicks the atom with a hand labeler to apply a label, this component gets applied to it.
|
|
If the labeler is off, the component will be removed from it, and the label will be removed from its name.
|
|
*/
|
|
/datum/component/label
|
|
dupe_mode = COMPONENT_DUPE_UNIQUE_PASSARGS
|
|
/// The name of the label the player is applying to the parent.
|
|
var/label_name
|
|
|
|
/datum/component/label/Initialize(_label_name)
|
|
if(!isatom(parent))
|
|
return COMPONENT_INCOMPATIBLE
|
|
|
|
label_name = _label_name
|
|
apply_label()
|
|
|
|
/datum/component/label/RegisterWithParent()
|
|
RegisterSignal(parent, COMSIG_PARENT_ATTACKBY, .proc/OnAttackby)
|
|
RegisterSignal(parent, COMSIG_PARENT_EXAMINE, .proc/Examine)
|
|
|
|
/datum/component/label/UnregisterFromParent()
|
|
UnregisterSignal(parent, list(COMSIG_PARENT_ATTACKBY, COMSIG_PARENT_EXAMINE))
|
|
|
|
/**
|
|
This proc will fire after the parent is hit by a hand labeler which is trying to apply another label.
|
|
Since the parent already has a label, it will remove the old one from the parent's name, and apply the new one.
|
|
*/
|
|
/datum/component/label/InheritComponent(datum/component/label/new_comp , i_am_original, _label_name)
|
|
remove_label()
|
|
if(new_comp)
|
|
label_name = new_comp.label_name
|
|
else
|
|
label_name = _label_name
|
|
apply_label()
|
|
|
|
/**
|
|
This proc will trigger when any object is used to attack the parent.
|
|
|
|
If the attacking object is not a hand labeler, it will return.
|
|
If the attacking object is a hand labeler it will restore the name of the parent to what it was before this component was added to it, and the component will be deleted.
|
|
|
|
Arguments:
|
|
* source: The parent.
|
|
* attacker: The object that is hitting the parent.
|
|
* user: The mob who is wielding the attacking object.
|
|
*/
|
|
/datum/component/label/proc/OnAttackby(datum/source, obj/item/attacker, mob/user)
|
|
SIGNAL_HANDLER
|
|
|
|
// If the attacking object is not a hand labeler or its mode is 1 (has a label ready to apply), return.
|
|
// The hand labeler should be off (mode is 0), in order to remove a label.
|
|
var/obj/item/hand_labeler/labeler = attacker
|
|
if(!istype(labeler) || labeler.mode)
|
|
return
|
|
|
|
remove_label()
|
|
playsound(parent, 'sound/items/poster_ripped.ogg', 20, TRUE)
|
|
to_chat(user, span_warning("You remove the label from [parent]."))
|
|
qdel(src) // Remove the component from the object.
|
|
|
|
/**
|
|
This proc will trigger when someone examines the parent.
|
|
It will attach the text found in the body of the proc to the `examine_list` and display it to the player examining the parent.
|
|
|
|
Arguments:
|
|
* source: The parent.
|
|
* user: The mob exmaining the parent.
|
|
* examine_list: The current list of text getting passed from the parent's normal examine() proc.
|
|
*/
|
|
/datum/component/label/proc/Examine(datum/source, mob/user, list/examine_list)
|
|
SIGNAL_HANDLER
|
|
|
|
examine_list += span_notice("It has a label with some words written on it. Use a hand labeler to remove it.")
|
|
|
|
/// Applies a label to the name of the parent in the format of: "parent_name (label)"
|
|
/datum/component/label/proc/apply_label()
|
|
var/atom/owner = parent
|
|
owner.name += " ([label_name])"
|
|
|
|
/// Removes the label from the parent's name
|
|
/datum/component/label/proc/remove_label()
|
|
var/atom/owner = parent
|
|
owner.name = replacetext(owner.name, "([label_name])", "") // Remove the label text from the parent's name, wherever it's located.
|
|
owner.name = trim(owner.name) // Shave off any white space from the beginning or end of the parent's name.
|