reagent

A single reagent

Vars
addiction_types	Assoc list with key type of addiction this reagent feeds, and value amount of addiction points added per unit of reagent metabolzied (which means * REAGENTS_METABOLISM every life())
burning_temperature	Thermodynamic vars How hot this reagent burns when it's on fire - null means it can't burn
burning_volume	How much is consumed when it is burnt per second
chemical_flags	See fermi_readme.dm REAGENT_DEAD_PROCESS, REAGENT_DONOTSPLIT, REAGENT_INVISIBLE, REAGENT_SNEAKYNAME, REAGENT_SPLITRETAINVOL, REAGENT_CANSYNTH, REAGENT_IMPURE
codex_mechanics	Text to insert into the "mechanics" section of the codex.
color	color it looks in containers etc
current_cycle	increments everytime on_mob_life is called
data	Special data associated with the reagent that will be passed on upon transfer to a new holder.
description	nor do they have descriptions
fallback_icon_state	fallback icon if the reagent has no glass or shot glass icon state. Used for restaurants.
glass_desc	desc applied to glasses with this reagent
glass_icon	Icon for the... glass.
glass_icon_state	Otherwise just sets the icon to a normal glass with the mixture of the reagents in the glass.
glass_name	use for specialty drinks.
glass_price	The amount a robot will pay for a glass of this (20 units but can be higher if you pour more, be frugal!)
harmful	is it bad for you? Currently only used for borghypo. C2s and Toxins have it TRUE by default.
holder	reagent holder this belongs to
ingest_met	How fast the reagent metabolizes when ingested. NOTE: Due to how reagents are coded, if you have an on_metabolize() for blood, this MUST be greater than metabolization_rate.
mass	The molar mass of the reagent - if you're adding a reagent that doesn't have a recipe, just add a random number between 10 - 800. Higher numbers are "harder" but it's mostly arbitary.
material	Are we from a material? We might wanna know that for special stuff. Like metalgen. Is replaced with a ref of the material on New()
metabolization_rate	how fast the reagent is metabolized by the mob
metabolizing	is it currently metabolizing
name	datums don't have names by default
overdose_threshold	above this overdoses happen
overdosed	You fucked up and this is now triggering its overdose effects, purge that shit quick.
penetrates_skin	The set of exposure methods this penetrates skin with.
reagent_state	LIQUID, SOLID, GAS
reagent_weight	affects how far it travels when sprayed
self_consuming	if false stops metab in liverless mobs
shot_glass_icon_state	used for shot glasses, mostly for alcohol
show_in_codex	Does this reagent and its recipe appear in the Codex?
specific_heat	J/(K*mol)
taste_description	used by taste messages
taste_mult	how this taste compares to others. Higher values means it is more noticable
touch_met	How fast the reagent metabolizes on touch
value	Cargo value per unit
volume	pretend this is moles
Procs
affect_ingest	Ingestion process. Call parent after your override's body, as holder can go null as a result of trans_id_to.
affect_touch	Touch process. Don't get covered in acid, now!
burn	Called whenever a reagent is on fire, or is in a holder that is on fire. (WIP)
expose_atom	Applies this reagent to an /atom
expose_mob	Applies this reagent to a /mob/living
expose_obj	Applies this reagent to an /obj
expose_turf	Applies this reagent to a /turf
get_taste_description	Should return a associative list where keys are taste descriptions and values are strength ratios
infuse_plant	Called by the Plantmaster to infuse a plant. Returns an amount to damage the plant. Args:
on_hydroponics_apply	New, standardized method for chemicals to affect hydroponics trays. Defined on a per-chem level as opposed to by the tray. Can affect plant's health, stats, or cause the plant to react in certain ways.
on_merge	Called when two reagents of the same are mixing.
on_mob_add	Called when this reagent is first added to a mob
on_mob_delete	Called when this reagent is removed while inside a mob
on_mob_end_metabolize	Called when this reagent stops being metabolized by a liver
on_mob_life	Called from /datum/reagents/proc/metabolize
on_mob_metabolize	Called when this reagent first starts being metabolized. Does NOT get called during microdoses, such as when going from stomach to blood.
on_new	Called after add_reagents creates a new reagent.
on_transfer	Called after a reagent is transfered
overdose_end	Called when an overdose ends
overdose_process	Called if the reagent has passed the overdose threshold and is set to be triggering overdose effects
overdose_start	Called when an overdose starts
purge_others	Removes OTHER reagents from the given holder.

Var Details

var
addiction_types
– /list

Assoc list with key type of addiction this reagent feeds, and value amount of addiction points added per unit of reagent metabolzied (which means * REAGENTS_METABOLISM every life())

var
burning_temperature

Thermodynamic vars How hot this reagent burns when it's on fire - null means it can't burn

var
burning_volume

How much is consumed when it is burnt per second

var
chemical_flags

See fermi_readme.dm REAGENT_DEAD_PROCESS, REAGENT_DONOTSPLIT, REAGENT_INVISIBLE, REAGENT_SNEAKYNAME, REAGENT_SPLITRETAINVOL, REAGENT_CANSYNTH, REAGENT_IMPURE

var
codex_mechanics

Text to insert into the "mechanics" section of the codex.

var
color

color it looks in containers etc

var
current_cycle

increments everytime on_mob_life is called

var
data
– /list

Special data associated with the reagent that will be passed on upon transfer to a new holder.

var
description

nor do they have descriptions

var
fallback_icon_state

fallback icon if the reagent has no glass or shot glass icon state. Used for restaurants.

var
glass_desc

desc applied to glasses with this reagent

var
glass_icon

Icon for the... glass.

var
glass_icon_state

Otherwise just sets the icon to a normal glass with the mixture of the reagents in the glass.

var
glass_name

use for specialty drinks.

var
glass_price

The amount a robot will pay for a glass of this (20 units but can be higher if you pour more, be frugal!)

var
harmful

is it bad for you? Currently only used for borghypo. C2s and Toxins have it TRUE by default.

var
holder
– /datum/reagents

reagent holder this belongs to

var
ingest_met

How fast the reagent metabolizes when ingested. NOTE: Due to how reagents are coded, if you have an on_metabolize() for blood, this MUST be greater than metabolization_rate.

var
mass

The molar mass of the reagent - if you're adding a reagent that doesn't have a recipe, just add a random number between 10 - 800. Higher numbers are "harder" but it's mostly arbitary.

var
material
– /datum/material

Are we from a material? We might wanna know that for special stuff. Like metalgen. Is replaced with a ref of the material on New()

var
metabolization_rate

how fast the reagent is metabolized by the mob

var
metabolizing

is it currently metabolizing

var
name

datums don't have names by default

var
overdose_threshold

above this overdoses happen

var
overdosed

You fucked up and this is now triggering its overdose effects, purge that shit quick.

var
penetrates_skin

The set of exposure methods this penetrates skin with.

var
reagent_state

LIQUID, SOLID, GAS

var
reagent_weight

affects how far it travels when sprayed

var
self_consuming

if false stops metab in liverless mobs

var
shot_glass_icon_state

used for shot glasses, mostly for alcohol

var
show_in_codex

Does this reagent and its recipe appear in the Codex?

var
specific_heat

J/(K*mol)

var
taste_description

used by taste messages

var
taste_mult

how this taste compares to others. Higher values means it is more noticable

var
touch_met

How fast the reagent metabolizes on touch

var
value

Cargo value per unit

var
volume

pretend this is moles

Proc Details

proc
affect_ingest
(/mob/living/carbon/C, removed)

Ingestion process. Call parent after your override's body, as holder can go null as a result of trans_id_to.

proc
affect_touch
(/mob/living/carbon/C, removed)

Touch process. Don't get covered in acid, now!

proc
burn
(/datum/reagents/holder)

Called whenever a reagent is on fire, or is in a holder that is on fire. (WIP)

proc
expose_atom
(/atom/exposed_atom, reac_volume, exposed_temperature, /datum/reagents/source)

Applies this reagent to an /atom

proc
expose_mob
(/mob/living/exposed_mob, reac_volume, exposed_temperature, /datum/reagents/source, methods, show_message, touch_protection)

Applies this reagent to a /mob/living

proc
expose_obj
(/obj/exposed_obj, reac_volume, exposed_temperature)

Applies this reagent to an /obj

proc
expose_turf
(/turf/exposed_turf, reac_volume, exposed_temperature)

Applies this reagent to a /turf

proc
get_taste_description
(/mob/living/taster)

Should return a associative list where keys are taste descriptions and values are strength ratios

proc
infuse_plant
(/datum/plant/plant_datum, /datum/plant_gene_holder/plant_dna, /list/damage_ref) as /obj/item/seeds

Called by the Plantmaster to infuse a plant. Returns an amount to damage the plant. Args:

plant_datum: The plant being infused.
plant_dna: The plant's gene holder.
damage_ref: Lists are references abuse. Add a number to the list to deal damage to the seed.

proc
on_hydroponics_apply
(/datum/plant_tick/plant_tick, /datum/reagents/chems, volume, /obj/machinery/hydroponics/mytray, /mob/user)

New, standardized method for chemicals to affect hydroponics trays. Defined on a per-chem level as opposed to by the tray. Can affect plant's health, stats, or cause the plant to react in certain ways.

proc
on_merge
(data, amount)

Called when two reagents of the same are mixing.

proc
on_mob_add
(/mob/living/carbon/C, amount, class)

Called when this reagent is first added to a mob

proc
on_mob_delete
(/mob/living/carbon/C, class)

Called when this reagent is removed while inside a mob

proc
on_mob_end_metabolize
(/mob/living/carbon/C, class)

Called when this reagent stops being metabolized by a liver

proc
on_mob_life
(/mob/living/carbon/M, location, do_addiction)

Called from /datum/reagents/proc/metabolize

proc
on_mob_metabolize
(/mob/living/carbon/C, class)

Called when this reagent first starts being metabolized. Does NOT get called during microdoses, such as when going from stomach to blood.

proc
on_new
(data)

Called after add_reagents creates a new reagent.

proc
on_transfer
(/atom/A, methods, trans_volume)

Called after a reagent is transfered

proc
overdose_end
(/mob/living/carbon/C)

Called when an overdose ends

proc
overdose_process
(/mob/living/carbon/C)

Called if the reagent has passed the overdose threshold and is set to be triggering overdose effects

proc
overdose_start
(/mob/living/carbon/C)

Called when an overdose starts

proc
purge_others
(/datum/reagents/holder, amount)

Removes OTHER reagents from the given holder.

reagent /datum/reagent

Vars

Procs

Var Details

var addiction_types – /list

var burning_temperature

var burning_volume

var chemical_flags

var codex_mechanics

var color

var current_cycle

var data – /list

var description

var fallback_icon_state

var glass_desc

var glass_icon

var glass_icon_state

var glass_name

var glass_price

var harmful

var holder – /datum/reagents

var ingest_met

var mass

var material – /datum/material

var metabolization_rate

var metabolizing

var name

var overdose_threshold

var overdosed

var penetrates_skin

var reagent_state

var reagent_weight

var self_consuming

var shot_glass_icon_state

var show_in_codex

var specific_heat

var taste_description

var taste_mult

var touch_met

var value

var volume