move all EOL comments on typepath names to dmdoc (#23928)

* move all EOL comments on typepath names to dmdoc

* Apply suggestions from code review

Co-authored-by: Luc <89928798+lewcc@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: S34N <12197162+S34NW@users.noreply.github.com>

---------

Co-authored-by: Luc <89928798+lewcc@users.noreply.github.com>
Co-authored-by: S34N <12197162+S34NW@users.noreply.github.com>
This commit is contained in:
warriorstar-orion
2024-03-01 20:05:49 +00:00
committed by GitHub
co-authored by Luc S34N
parent 25996e232a
commit 0667f20681
211 changed files with 955 additions and 478 deletions
@@ -1,4 +1,5 @@
/datum/reagent/medicine/adminordrazine //An OP chemical for admins
/// An OP chemical for admins
/datum/reagent/medicine/adminordrazine
name = "Adminordrazine"
id = "adminordrazine"
description = "It's magic. We don't have to explain it."
@@ -230,7 +230,8 @@
drink_desc = "Damn, you feel like some kind of French aristocrat just by holding this."
taste_description = "cognac"
/datum/reagent/consumable/ethanol/suicider //otherwise known as "I want to get so smashed my liver gives out and I die from alcohol poisoning".
/// otherwise known as "I want to get so smashed my liver gives out and I die from alcohol poisoning".
/datum/reagent/consumable/ethanol/suicider
name = "Suicider"
id = "suicider"
description = "An unbelievably strong and potent variety of Cider."
@@ -1155,7 +1156,8 @@
drink_desc = "For enjoying the most wonderful time of the year."
taste_description = "christmas spirit"
/datum/reagent/consumable/ethanol/dragons_breath //inaccessible to players, but here for admin shennanigans
/// inaccessible to players, but here for admin shennanigans
/datum/reagent/consumable/ethanol/dragons_breath
name = "Dragon's Breath"
id = "dragonsbreath"
description = "Possessing this stuff probably breaks the Geneva convention."
@@ -1409,7 +1411,8 @@
#undef MIN_WINE_PERCENT
/datum/reagent/consumable/ethanol/bacchus_blessing //An EXTREMELY powerful drink. Smashed in seconds, dead in minutes.
/// An EXTREMELY powerful drink. Smashed in seconds, dead in minutes.
/datum/reagent/consumable/ethanol/bacchus_blessing
name = "Bacchus' Blessing"
id = "bacchus_blessing"
description = "Unidentifiable mixture. Unmeasurably high alcohol content."
@@ -12,7 +12,8 @@
/datum/reagent/blob/proc/damage_reaction(obj/structure/blob/B, damage, damage_type, damage_flag) //when the blob takes damage, do this
return damage
/datum/reagent/blob/ripping_tendrils //does brute and a little stamina damage
/// does brute and a little stamina damage
/datum/reagent/blob/ripping_tendrils
name = "Ripping Tendrils"
description = "Deals High Brute damage, as well as Stamina damage."
id = "ripping_tendrils"
@@ -28,7 +29,8 @@
if(iscarbon(M))
M.emote("scream")
/datum/reagent/blob/boiling_oil //sets you on fire, does burn damage
/// sets you on fire, does burn damage
/datum/reagent/blob/boiling_oil
name = "Boiling Oil"
description = "Deals High Burn damage, and sets the victim aflame."
id = "boiling_oil"
@@ -45,7 +47,8 @@
M.IgniteMob()
M.emote("scream")
/datum/reagent/blob/envenomed_filaments //toxin, hallucination, and some bonus spore toxin
/// toxin, hallucination, and some bonus spore toxin
/datum/reagent/blob/envenomed_filaments
name = "Envenomed Filaments"
description = "Deals High Toxin damage, causes Hallucinations, and injects Spores into the bloodstream."
id = "envenomed_filaments"
@@ -61,7 +64,8 @@
if(M.reagents)
M.reagents.add_reagent("spore", 0.4*volume)
/datum/reagent/blob/lexorin_jelly //does tons of oxygen damage and a little brute
/// does tons of oxygen damage and a little brute
/datum/reagent/blob/lexorin_jelly
name = "Lexorin Jelly"
description = "Deals Medium Brute damage, but massive amounts of Respiration Damage."
id = "lexorin_jelly"
@@ -77,7 +81,8 @@
M.AdjustLoseBreath(round(0.6 SECONDS * volume))
/datum/reagent/blob/kinetic //does semi-random brute damage
/// does semi-random brute damage
/datum/reagent/blob/kinetic
name = "Kinetic Gelatin"
description = "Deals Randomized damage, between 0.33 to 2.33 times the standard amount."
id = "kinetic"
@@ -91,7 +96,8 @@
var/damage = rand(5, 35)/25
M.apply_damage(damage*volume, BRUTE)
/datum/reagent/blob/cryogenic_liquid //does low burn damage and stamina damage and cools targets down
/// does low burn damage and stamina damage and cools targets down
/datum/reagent/blob/cryogenic_liquid
name = "Cryogenic Liquid"
description = "Deals Medium Brute damage, Stamina Damage, and injects Frost Oil into its victims, freezing them to death."
id = "cryogenic_liquid"
@@ -775,7 +775,8 @@
M.emote("laugh")
return list(effect, update_flags)
/datum/reagent/rotatium //Rotatium. Fucks up your rotation and is hilarious
/// Rotatium. Fucks up your rotation and is hilarious
/datum/reagent/rotatium
name = "Rotatium"
id = "rotatium"
description = "A constantly swirling, oddly colourful fluid. Causes the consumer's sense of direction and hand-eye coordination to become wild."
@@ -19,7 +19,8 @@
H.adjust_nutrition(nutriment_factor) // For hunger and fatness
return ..()
/datum/reagent/consumable/nutriment // Pure nutriment, universally digestable and thus slightly less effective
/// Pure nutriment, universally digestable and thus slightly less effective
/datum/reagent/consumable/nutriment
name = "Nutriment"
id = "nutriment"
description = "A questionable mixture of various pure nutrients commonly found in processed foods."
@@ -62,13 +63,15 @@
counterlist_normalise(taste_amounts)
data = taste_amounts
/datum/reagent/consumable/nutriment/protein // Meat-based protein, digestable by carnivores and omnivores, worthless to herbivores
/// Meat-based protein, digestable by carnivores and omnivores, worthless to herbivores
/datum/reagent/consumable/nutriment/protein
name = "Protein"
id = "protein"
description = "Various essential proteins and fats commonly found in animal flesh and blood."
diet_flags = DIET_CARN | DIET_OMNI
/datum/reagent/consumable/nutriment/plantmatter // Plant-based biomatter, digestable by herbivores and omnivores, worthless to carnivores
/// Plant-based biomatter, digestable by herbivores and omnivores, worthless to carnivores
/datum/reagent/consumable/nutriment/plantmatter
name = "Plant-matter"
id = "plantmatter"
description = "Vitamin-rich fibers and natural sugars commonly found in fresh produce."
@@ -813,7 +816,8 @@
///Food Related, but non-nutritious
/datum/reagent/questionmark // food poisoning
/// food poisoning
/datum/reagent/questionmark
name = "????"
id = "????"
description = "A gross and unidentifiable substance."
@@ -1258,7 +1258,8 @@
M.Drowsy(40 SECONDS)
return ..() | update_flags
/datum/reagent/medicine/syndicate_nanites //Used exclusively by Syndicate medical cyborgs
/// Used exclusively by Syndicate medical cyborgs
/datum/reagent/medicine/syndicate_nanites
name = "Restorative Nanites"
id = "syndicate_nanites"
description = "Miniature medical robots that swiftly restore bodily damage. May begin to attack their host's cells in high amounts."
@@ -1400,7 +1401,8 @@
return ..() | update_flags
/datum/reagent/medicine/earthsblood //Created by ambrosia gaia plants
/// Created by ambrosia gaia plants
/datum/reagent/medicine/earthsblood
name = "Earthsblood"
id = "earthsblood"
description = "Ichor from an extremely powerful plant. Great for restoring wounds, but it's a little heavy on the brain."
@@ -447,7 +447,8 @@
/datum/reagent/love/reaction_mob(mob/living/M, method=REAGENT_TOUCH, volume)
to_chat(M, "<span class='notice'>You feel loved!</span>")
/datum/reagent/jestosterone //Formerly known as Nitrogen tungstide hypochlorite before NT fired the chemists for trying to be funny
/// Formerly known as Nitrogen tungstide hypochlorite before NT fired the chemists for trying to be funny
/datum/reagent/jestosterone
name = "Jestosterone"
id = "jestosterone"
description = "Jestosterone is an odd chemical compound that induces a variety of annoying side-effects in the average person. It also causes mild intoxication, and is toxic to mimes."
@@ -452,7 +452,8 @@
M.EyeBlurry(6 SECONDS)
return ..() | update_flags
/datum/reagent/beer2 //disguised as normal beer for use by emagged service borgs
/// disguised as normal beer for use by emagged service borgs
/datum/reagent/beer2
name = "Beer"
id = "beer2"
description = "An alcoholic beverage made from malted grains, hops, yeast, and water."
@@ -1082,7 +1083,8 @@
lethality = 2 //Atrazine, however, is definitely toxic
/datum/reagent/pestkiller // To-Do; make this more realistic.
/// To-Do; make this more realistic.
/datum/reagent/pestkiller
name = "Pest Killer"
id = "pestkiller"
description = "A harmful toxic mixture to kill pests. Do not ingest!"
@@ -1237,7 +1239,8 @@
M.emote("scream")
M.adjustBruteLoss(4)
/datum/reagent/teslium //Teslium. Causes periodic shocks, and makes shocks against the target much more effective.
/// Teslium. Causes periodic shocks, and makes shocks against the target much more effective.
/datum/reagent/teslium
name = "Teslium"
id = "teslium"
description = "An unstable, electrically-charged metallic slurry. Increases the conductance of living things."
@@ -1281,7 +1284,8 @@
playsound(M, "sparks", 50, TRUE, SHORT_RANGE_SOUND_EXTRARANGE)
chosen_timer = rand(shock_low, shock_high) //It needs to be randomised here for blob teslium, and randoming it here doesn't affect normal
/datum/reagent/teslium/blob //This version has it's shocks much less frequently, while retaining the shock multiplier
/// This version has it's shocks much less frequently, while retaining the shock multiplier
/datum/reagent/teslium/blob
id = "blob_teslium"
shock_low = 10
use_chaotic_random = FALSE
@@ -363,7 +363,8 @@
qdel(R)
T.Bless()
/datum/reagent/fuel/unholywater //if you somehow managed to extract this from someone, dont splash it on yourself and have a smoke
/// if you somehow managed to extract this from someone, dont splash it on yourself and have a smoke
/datum/reagent/fuel/unholywater
name = "Unholy Water"
id = "unholywater"
description = "Something that shouldn't exist on this plane of existence."
@@ -225,7 +225,8 @@
result_amount = 2
mix_message = "The substance becomes a pile of burning dust."
/datum/chemical_reaction/phlogiston_fire //This MUST be above the smoke recipe.
/// This MUST be above the smoke recipe.
/datum/chemical_reaction/phlogiston_fire
name = "Phlogiston Fire"
id = "phlogiston_fire"
result = "phlogiston"
@@ -108,7 +108,8 @@
result_amount = 3
mix_message = "The mixture gives off a harsh odor"
/datum/chemical_reaction/pestkiller // To-Do make this more realistic
/// To-Do make this more realistic
/datum/chemical_reaction/pestkiller
name = "Pest Killer"
id = "pestkiller"
result = "pestkiller"
@@ -144,5 +144,6 @@
name = "dual auto-mender"
list_reagents = list("synthflesh" = 200)
/obj/item/reagent_containers/applicator/dual/syndi // It magically goes through hardsuits. Don't ask how.
/// It magically goes through hardsuits. Don't ask how.
/obj/item/reagent_containers/applicator/dual/syndi
ignore_flags = TRUE
@@ -116,7 +116,8 @@
volume = 100
list_reagents = list("nanites" = 100)
/obj/item/reagent_containers/hypospray/autoinjector // This is an empty variant
/// This is an empty variant
/obj/item/reagent_containers/hypospray/autoinjector
name = "empty autoinjector"
desc = "A rapid and safe way to inject chemicals into humanoids. This one is empty."
icon_state = "autoinjector"
@@ -160,13 +161,15 @@
desc = "A rapid and safe way to stabilize patients in critical condition for personnel without advanced medical knowledge."
list_reagents = list("epinephrine" = 10)
/obj/item/reagent_containers/hypospray/autoinjector/teporone //basilisks
/// basilisks
/obj/item/reagent_containers/hypospray/autoinjector/teporone
name = "teporone autoinjector"
desc = "A rapid way to regulate your body's temperature in the event of a hardsuit malfunction."
icon_state = "lepopen"
list_reagents = list("teporone" = 10)
/obj/item/reagent_containers/hypospray/autoinjector/stimpack //goliath kiting
/// goliath kiting
/obj/item/reagent_containers/hypospray/autoinjector/stimpack
name = "stimpack autoinjector"
desc = "A rapid way to stimulate your body's adrenaline, allowing for freer movement in restrictive armor."
icon_state = "stimpen"
@@ -163,7 +163,8 @@
. = ..()
name = "[initial(name)] - Saline Glucose"
/obj/item/reagent_containers/iv_bag/blood // Don't use this - just an abstract type to allow blood bags to have a common blood_type var for ease of creation.
/// Don't use this - just an abstract type to allow blood bags to have a common blood_type var for ease of creation.
/obj/item/reagent_containers/iv_bag/blood
var/blood_type
var/blood_species = "Synthetic humanoid"
var/iv_blood_colour = "#A10808"
@@ -273,8 +273,9 @@
to_chat(user, "<span class='notice'>You adjust the output switch. You'll now use [amount_per_transfer_from_this] units per spray.</span>")
// Plant-B-Gone
/obj/item/reagent_containers/spray/plantbgone // -- Skie
/// Plant-B-Gone
/// -- Skie
/obj/item/reagent_containers/spray/plantbgone
name = "Plant-B-Gone"
desc = "Kills those pesky weeds!"
icon = 'icons/obj/hydroponics/equipment.dmi'