White Sands - Modules - TypesVar Details - Proc Details

Reagent

A single reagent

Vars

addiction_stageincreases as addiction gets worse
addiction_thresholdabove this amount addictions start
can_synthcan this reagent be synthesized? (for example: odysseus syringe gun)
colorcolor it looks in containers etc
current_cycleincrements everytime on_mob_life is called
dataspecial data associated with this like viruses etc
descriptionnor do they have descriptions
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.
harmfulis it bad for you? Currently only used for borghypo. C2s and Toxins have it TRUE by default.
holderreagent holder this belongs to
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
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

addiction_act_stage1Called when addiction hits stage1, see /datum/reagents/proc/metabolize
addiction_act_stage2Called when addiction hits stage2, see /datum/reagents/proc/metabolize
addiction_act_stage3Called when addiction hits stage3, see /datum/reagents/proc/metabolize
addiction_act_stage4Called when addiction hits stage4, see /datum/reagents/proc/metabolize
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
on_ex_actCalled when the reagent container is hit by an explosion
on_mergeCalled when two reagents of the same are mixing.
on_mob_addCalled when this reagent is first added to a mob
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_temp_changecalled on expose_temperature
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_stage

increases as addiction gets worse

addiction_threshold

above this amount addictions start

can_synth

can this reagent be synthesized? (for example: odysseus syringe gun)

color

color it looks in containers etc

current_cycle

increments everytime on_mob_life is called

data

special data associated with this like viruses etc

description

nor do they have descriptions

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.

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

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

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

addiction_act_stage1

Called when addiction hits stage1, see /datum/reagents/proc/metabolize

addiction_act_stage2

Called when addiction hits stage2, see /datum/reagents/proc/metabolize

addiction_act_stage3

Called when addiction hits stage3, see /datum/reagents/proc/metabolize

addiction_act_stage4

Called when addiction hits stage4, see /datum/reagents/proc/metabolize

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

on_ex_act

Called when the reagent container is hit by an explosion

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

on_move

Called by /datum/reagents/proc/conditional_update_move

on_new

Called after add_reagents creates a new reagent.

on_temp_change

called on expose_temperature

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