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())
affected_biotype	The affected biotype, if the reagent damages/heals toxin damage of an affected mob. See "Mob bio-types flags" in /code/_DEFINES/mobs.dm
affected_bodytype	The affected bodytype, if the reagent damages/heals bodyparts (Brute/Fire) of an affected mob. See "Bodytype defines" in /code/_DEFINES/mobs.dm
affected_organ_flags	The affected organ_flags, if the reagent damages/heals organ damage of an affected mob. See "Organ defines for carbon mobs" in /code/_DEFINES/surgery.dm
affected_respiration_type	The affected respiration type, if the reagent damages/heals oxygen damage of an affected mob. See "Mob bio-types flags" in /code/_DEFINES/mobs.dm
burning_temperature	what chem is made at the end of a reaction IF the purity is below the recipies purity_min at the END of a reaction only 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
color	color it looks in containers etc
creation_purity	the purity of the reagent on creation (i.e. when it's added to a mob and it's purity split it into 2 chems; the purity of the resultant chems are kept as 1, this tracks what the purity was before that)
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.
default_container	The default reagent container for the reagent, used for icon generation
description	nor do they have descriptions
fallback_icon	Icon for fallback item displayed in a tourist's thought bubble for if this reagent had no associated glass_style datum.
fallback_icon_state	Icon state for fallback item displayed in a tourist's thought bubble for if this reagent had no associated glass_style datum.
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!)
holder	reagent holder this belongs to
inverse_chem	What chem is metabolised when purity is below inverse_chem_val
inverse_chem_val	If the impurity is below 0.5, replace ALL of the chem with inverse_chem upon metabolising
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.
ph	pH of the reagent
purity	Purity of the reagent - for use with internal reaction mechanics only. Use below (creation_purity) if you're writing purity effects into a reagent's use mechanics.
reagent_removal_skip_list	A list of causes why this chem should skip being removed, if the length is 0 it will be removed from holder naturally, if this is >0 it will not be removed from the holder.
reagent_state	LIQUID, SOLID, GAS
reagent_weight	affects how far it travels when sprayed
restaurant_order	When ordered in a restaurant, what custom order do we create?
self_consuming	if false stops metab in liverless mobs
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
volume	pretend this is moles
Procs
Destroy	This should only be called by the holder, so it's already handled clearing its references
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_inverse_purity	Gets the inverse purity of this reagent. Mostly used when converting from a normal reagent to it's inverse one.
get_taste_description	Should return a associative list where keys are taste descriptions and values are strength ratios
metabolize_reagent	Metabolizes a portion of the reagent after on_mob_life() is called
normalise_creation_purity	Used when you want the default reagents purity to be equal to the normal effects (i.e. if default purity is 0.75, and your reacted purity is 1, then it will return 1.33)
on_burn_wound_processing	Called in burns.dm if the reagent has the REAGENT_AFFECTS_WOUNDS process flag
on_hydroponics_apply	Called when this chemical is processed in a hydroponics tray.
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_dead	Called when a reagent is inside of a mob when they are dead if the reagent has the REAGENT_DEAD_PROCESS flag Returning UPDATE_MOB_HEALTH will cause updatehealth() to be called on the holder mob by /datum/reagents/proc/metabolize.
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	Ticks on mob Life() for as long as the reagent remains in the mob's reagents.
on_mob_metabolize	Called when this reagent first starts being metabolized by a liver
on_new	Called after add_reagents creates a new reagent.
on_transfer	Called after a reagent is transferred
overdose_process	Called if the reagent has passed the overdose threshold and is set to be triggering overdose effects. Returning UPDATE_MOB_HEALTH will cause updatehealth() to be called on the holder mob by /datum/reagents/proc/metabolize.
overdose_start	Called when an overdose starts. Returning UPDATE_MOB_HEALTH will cause updatehealth() to be called on the holder mob by /datum/reagents/proc/metabolize.

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
affected_biotype
–

The affected biotype, if the reagent damages/heals toxin damage of an affected mob. See "Mob bio-types flags" in /code/_DEFINES/mobs.dm

var
affected_bodytype
–

The affected bodytype, if the reagent damages/heals bodyparts (Brute/Fire) of an affected mob. See "Bodytype defines" in /code/_DEFINES/mobs.dm

var
affected_organ_flags
–

The affected organ_flags, if the reagent damages/heals organ damage of an affected mob. See "Organ defines for carbon mobs" in /code/_DEFINES/surgery.dm

var
affected_respiration_type
–

The affected respiration type, if the reagent damages/heals oxygen damage of an affected mob. See "Mob bio-types flags" in /code/_DEFINES/mobs.dm

var
burning_temperature
–

what chem is made at the end of a reaction IF the purity is below the recipies purity_min at the END of a reaction only 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
color
–

color it looks in containers etc

var
creation_purity
–

the purity of the reagent on creation (i.e. when it's added to a mob and it's purity split it into 2 chems; the purity of the resultant chems are kept as 1, this tracks what the purity was before that)

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
default_container
– /obj/item/reagent_containers

The default reagent container for the reagent, used for icon generation

var
description
–

nor do they have descriptions

var
fallback_icon
–

Icon for fallback item displayed in a tourist's thought bubble for if this reagent had no associated glass_style datum.

var
fallback_icon_state
–

Icon state for fallback item displayed in a tourist's thought bubble for if this reagent had no associated glass_style datum.

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
holder
– /datum/reagents

reagent holder this belongs to

var
inverse_chem
–

What chem is metabolised when purity is below inverse_chem_val

var
inverse_chem_val
–

If the impurity is below 0.5, replace ALL of the chem with inverse_chem upon metabolising

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
ph
–

pH of the reagent

var
purity
–

Purity of the reagent - for use with internal reaction mechanics only. Use below (creation_purity) if you're writing purity effects into a reagent's use mechanics.

var
reagent_removal_skip_list
– /list

A list of causes why this chem should skip being removed, if the length is 0 it will be removed from holder naturally, if this is >0 it will not be removed from the holder.

var
reagent_state
–

LIQUID, SOLID, GAS

var
reagent_weight
–

affects how far it travels when sprayed

var
restaurant_order
–

When ordered in a restaurant, what custom order do we create?

var
self_consuming
–

if false stops metab in liverless mobs

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
volume
–

pretend this is moles

Proc Details

↑
Destroy
()

This should only be called by the holder, so it's already handled clearing its references

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)

Applies this reagent to an /atom

proc
expose_mob
(/mob/living/exposed_mob, methods, reac_volume, show_message, touch_protection)

Applies this reagent to a /mob/living

proc
expose_obj
(/obj/exposed_obj, reac_volume)

Applies this reagent to an /obj

proc
expose_turf
(/turf/exposed_turf, reac_volume)

Applies this reagent to a /turf

proc
get_inverse_purity
(purity)

Gets the inverse purity of this reagent. Mostly used when converting from a normal reagent to it's inverse one.

Arguments

purity - Overrides the purity used for determining the inverse purity.

proc
get_taste_description
(/mob/living/taster)

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

proc
metabolize_reagent
(/mob/living/carbon/affected_mob, seconds_per_tick, times_fired)

Metabolizes a portion of the reagent after on_mob_life() is called

proc
normalise_creation_purity
(normalise_num_to, creation_purity)

Used when you want the default reagents purity to be equal to the normal effects (i.e. if default purity is 0.75, and your reacted purity is 1, then it will return 1.33)

Arguments

normalise_num_to - what number/purity value you're normalising to. If blank it will default to the compile value of purity for this chem
creation_purity - creation_purity override, if desired. This is the purity of the reagent that you're normalising from.

proc
on_burn_wound_processing
(/datum/wound/burn/flesh/burn_wound)

Called in burns.dm if the reagent has the REAGENT_AFFECTS_WOUNDS process flag

proc
on_hydroponics_apply
(/obj/machinery/hydroponics/mytray, /mob/user)

Called when this chemical is processed in a hydroponics 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/affected_mob, amount)

Called when this reagent is first added to a mob

proc
on_mob_dead
(/mob/living/carbon/affected_mob, seconds_per_tick)

Called when a reagent is inside of a mob when they are dead if the reagent has the REAGENT_DEAD_PROCESS flag Returning UPDATE_MOB_HEALTH will cause updatehealth() to be called on the holder mob by /datum/reagents/proc/metabolize.

proc
on_mob_delete
(/mob/living/affected_mob)

Called when this reagent is removed while inside a mob

proc
on_mob_end_metabolize
(/mob/living/affected_mob)

Called when this reagent stops being metabolized by a liver

proc
on_mob_life
(/mob/living/carbon/affected_mob, seconds_per_tick, times_fired)

Ticks on mob Life() for as long as the reagent remains in the mob's reagents.

Usage: Parent should be called first using . = ..()

Exceptions: If the holder var needs to be accessed, call the parent afterward that as it can become null if the reagent is fully removed.

Returns: UPDATE_MOB_HEALTH only if you need to update the health of a mob (this is only needed when damage is dealt to the mob)

Arguments

mob/living/carbon/affected_mob - the mob which the reagent currently is inside of
seconds_per_tick - the time in server seconds between proc calls (when performing normally it will be 2)
times_fired - the number of times the owner's Life() tick has been called aka The number of times SSmobs has fired

proc
on_mob_metabolize
(/mob/living/affected_mob)

Called when this reagent first starts being metabolized by a liver

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 transferred

proc
overdose_process
(/mob/living/affected_mob, seconds_per_tick, times_fired)

Called if the reagent has passed the overdose threshold and is set to be triggering overdose effects. Returning UPDATE_MOB_HEALTH will cause updatehealth() to be called on the holder mob by /datum/reagents/proc/metabolize.

proc
overdose_start
(/mob/living/affected_mob)

Called when an overdose starts. Returning UPDATE_MOB_HEALTH will cause updatehealth() to be called on the holder mob by /datum/reagents/proc/metabolize.

reagent /datum/reagent

Vars

Procs

Var Details

var addiction_types – /list

var affected_biotype –

var affected_bodytype –

var affected_organ_flags –

var affected_respiration_type –

var burning_temperature –

var burning_volume –

var chemical_flags –

var color –

var creation_purity –

var current_cycle –

var data – /list

var default_container – /obj/item/reagent_containers

var description –

var fallback_icon –

var fallback_icon_state –

var glass_price –

var holder – /datum/reagents

var inverse_chem –

var inverse_chem_val –

var mass –

var material – /datum/material

var metabolization_rate –

var metabolizing –

var name –

var overdose_threshold –

var overdosed –

var penetrates_skin –

var ph –

var purity –

var reagent_removal_skip_list – /list

var reagent_state –

var reagent_weight –

var restaurant_order –

var self_consuming –

var specific_heat –

var taste_description –

var taste_mult –

var volume –

Proc Details

↑Destroy()

proc burn(/datum/reagents/holder)

proc expose_atom(/atom/exposed_atom, reac_volume)

proc expose_mob(/mob/living/exposed_mob, methods, reac_volume, show_message, touch_protection)

proc expose_obj(/obj/exposed_obj, reac_volume)

proc expose_turf(/turf/exposed_turf, reac_volume)

proc get_inverse_purity(purity)

proc get_taste_description(/mob/living/taster)

proc metabolize_reagent(/mob/living/carbon/affected_mob, seconds_per_tick, times_fired)

proc normalise_creation_purity(normalise_num_to, creation_purity)

proc on_burn_wound_processing(/datum/wound/burn/flesh/burn_wound)

proc on_hydroponics_apply(/obj/machinery/hydroponics/mytray, /mob/user)

proc on_merge(data, amount)

proc on_mob_add(/mob/living/affected_mob, amount)

proc on_mob_dead(/mob/living/carbon/affected_mob, seconds_per_tick)

proc on_mob_delete(/mob/living/affected_mob)

proc on_mob_end_metabolize(/mob/living/affected_mob)

proc on_mob_life(/mob/living/carbon/affected_mob, seconds_per_tick, times_fired)

proc on_mob_metabolize(/mob/living/affected_mob)

proc on_new(data)

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

proc overdose_process(/mob/living/affected_mob, seconds_per_tick, times_fired)

proc overdose_start(/mob/living/affected_mob)

reagent
/datum/reagent

var
addiction_types
– /list

var
affected_biotype
–

var
affected_bodytype
–

var
affected_organ_flags
–

var
affected_respiration_type
–

var
burning_temperature
–

var
burning_volume
–

var
chemical_flags
–

var
color
–

var
creation_purity
–

var
current_cycle
–

var
data
– /list

var
default_container
– /obj/item/reagent_containers

var
description
–

var
fallback_icon
–

var
fallback_icon_state
–

var
glass_price
–

var
holder
– /datum/reagents

var
inverse_chem
–

var
inverse_chem_val
–

var
mass
–

var
material
– /datum/material

var
metabolization_rate
–

var
metabolizing
–

var
name
–

var
overdose_threshold
–

var
overdosed
–

var
penetrates_skin
–

var
ph
–

var
purity
–

var
reagent_removal_skip_list
– /list

var
reagent_state
–

var
reagent_weight
–

var
restaurant_order
–

var
self_consuming
–

var
specific_heat
–

var
taste_description
–

var
taste_mult
–

var
volume
–

↑
Destroy
()

proc
burn
(/datum/reagents/holder)

proc
expose_atom
(/atom/exposed_atom, reac_volume)

proc
expose_mob
(/mob/living/exposed_mob, methods, reac_volume, show_message, touch_protection)

proc
expose_obj
(/obj/exposed_obj, reac_volume)

proc
expose_turf
(/turf/exposed_turf, reac_volume)

proc
get_inverse_purity
(purity)

proc
get_taste_description
(/mob/living/taster)

proc
metabolize_reagent
(/mob/living/carbon/affected_mob, seconds_per_tick, times_fired)

proc
normalise_creation_purity
(normalise_num_to, creation_purity)

proc
on_burn_wound_processing
(/datum/wound/burn/flesh/burn_wound)

proc
on_hydroponics_apply
(/obj/machinery/hydroponics/mytray, /mob/user)

proc
on_merge
(data, amount)

proc
on_mob_add
(/mob/living/affected_mob, amount)

proc
on_mob_dead
(/mob/living/carbon/affected_mob, seconds_per_tick)

proc
on_mob_delete
(/mob/living/affected_mob)

proc
on_mob_end_metabolize
(/mob/living/affected_mob)

proc
on_mob_life
(/mob/living/carbon/affected_mob, seconds_per_tick, times_fired)

proc
on_mob_metabolize
(/mob/living/affected_mob)

proc
on_new
(data)

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

proc
overdose_process
(/mob/living/affected_mob, seconds_per_tick, times_fired)

proc
overdose_start
(/mob/living/affected_mob)