/tg/ Station 13 - Modules - TypesVar Details - Proc Details

reagent

A single reagent

Vars

addiction_typesAssoc 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_temperatureThermodynamic vars How hot this reagent burns when it's on fire - null means it can't burn
burning_volumeHow much is consumed when it is burnt per second
chemical_flagsSee fermi_readme.dm REAGENT_DEAD_PROCESS, REAGENT_DONOTSPLIT, REAGENT_INVISIBLE, REAGENT_SNEAKYNAME, REAGENT_SPLITRETAINVOL, REAGENT_CANSYNTH, REAGENT_IMPURE
colorcolor it looks in containers etc
creation_puritythe 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_cycleincrements everytime on_mob_life is called
dataSpecial data associated with the reagent that will be passed on upon transfer to a new holder.
descriptionnor do they have descriptions
failed_chemwhat 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
fallback_icon_statefallback icon if the reagent has no glass or shot glass icon state. Used for restaurants.
glass_descdesc applied to glasses with this reagent
glass_icon_stateOtherwise just sets the icon to a normal glass with the mixture of the reagents in the glass.
glass_nameuse for specialty drinks.
glass_priceThe amount a robot will pay for a glass of this (20 units but can be higher if you pour more, be frugal!)
harmfulis it bad for you? Currently only used for borghypo. C2s and Toxins have it TRUE by default.
holderreagent holder this belongs to
impure_chemimpure chem values (see fermi_readme.dm for more details on impure/inverse/failed mechanics): What chemical path is made when metabolised as a function of purity
inverse_chemWhat chem is metabolised when purity is below inverse_chem_val
inverse_chem_valIf the impurity is below 0.5, replace ALL of the chem with inverse_chem upon metabolising
massThe 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.
materialAre 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_ratehow fast the reagent is metabolized by the mob
metabolizingis it currently metabolizing
namedatums don't have names by default
overdose_thresholdabove this overdoses happen
overdosedYou fucked up and this is now triggering its overdose effects, purge that shit quick.
overrides_metabappears unused
penetrates_skinThe set of exposure methods this penetrates skin with.
phpH of the reagent
purityPurity 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_listA 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_stateLIQUID, SOLID, GAS
reagent_weightaffects how far it travels when sprayed
self_consumingif false stops metab in liverless mobs
shot_glass_icon_stateused for shot glasses, mostly for alcohol
specific_heatJ/(K*mol)
taste_descriptionused by taste messages
taste_multhow this taste compares to others. Higher values means it is more noticable
volumepretend this is moles

Procs

burnCalled whenever a reagent is on fire, or is in a holder that is on fire. (WIP)
expose_atomApplies this reagent to an /atom
expose_mobApplies this reagent to a /mob/living
expose_objApplies this reagent to an /obj
expose_turfApplies this reagent to a /turf
get_taste_descriptionShould return a associative list where keys are taste descriptions and values are strength ratios
normalise_creation_purityUsed 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_hydroponics_applyNew, 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_mergeCalled when two reagents of the same are mixing.
on_mob_addCalled when this reagent is first added to a mob
on_mob_deadCalled when a reagent is inside of a mob when they are dead
on_mob_deleteCalled when this reagent is removed while inside a mob
on_mob_end_metabolizeCalled when this reagent stops being metabolized by a liver
on_mob_lifeCalled from /datum/reagents/proc/metabolize
on_mob_metabolizeCalled when this reagent first starts being metabolized by a liver
on_moveCalled by /datum/reagents/proc/conditional_update_move
on_newCalled after add_reagents creates a new reagent.
on_transferCalled after a reagent is transfered
on_updateCalled by /datum/reagents/proc/conditional_update
overdose_processCalled if the reagent has passed the overdose threshold and is set to be triggering overdose effects
overdose_startCalled when an overdose starts

Var Details

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

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.

description

nor do they have descriptions

failed_chem

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

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_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

impure_chem

impure chem values (see fermi_readme.dm for more details on impure/inverse/failed mechanics): What chemical path is made when metabolised as a function of purity

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.

overrides_metab

appears unused

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

self_consuming

if false stops metab in liverless mobs

shot_glass_icon_state

used for shot glasses, mostly for alcohol

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

Proc Details

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

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)

Arguments

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_dead

Called when a reagent is inside of a mob when they are dead

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 by a liver

on_move

Called by /datum/reagents/proc/conditional_update_move

on_new

Called after add_reagents creates a new reagent.

on_transfer

Called after a reagent is transfered

on_update

Called by /datum/reagents/proc/conditional_update

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