gas_mixture

Vars
analyzer_results	Used for analyzer feedback - not initialized until its used
gc_share	Whether to call garbage_collect() on the sharer during shares, used for immutable mixtures
reaction_results	The fire key contains information that might determine the volume of hotspots.
Procs
add_gas	add_gas(gas_id) - similar to assert_gas(), but does not check for an existing gas list for this id. This can clobber existing gases. Used instead of assert_gas() when you know the gas does not exist. Faster than assert_gas().
add_gases	add_gases(args) - shorthand for calling add_gas() once for each gas_type.
archive	Update archived versions of variables. Returns: 1 in all cases
assert_gas	assert_gas(gas_id) - used to guarantee that the gas list for this id exists in gas_mixture.gases. Must be used before adding to a gas. May be used before reading from a gas.
assert_gases	assert_gases(args) - shorthand for calling ASSERT_GAS() once for each gas type.
compare	Compares sample to self to see if within acceptable ranges that group processing may be enabled Returns: a string indicating what check failed, or "" if check passes
copy	Creates new, identical gas mixture Returns: duplicate gas mixture
copy_from	Copies variables from sample, moles multiplicated by partial Returns: 1 if we are mutable, 0 otherwise
copy_from_turf	Copies all gas info from the turf into the gas list along with temperature Returns: TRUE if we are mutable, FALSE otherwise
equalize	Distributes the contents of two mixes equally between themselves
garbage_collect	garbage_collect() - removes any gas list which is empty. If called with a list as an argument, only removes gas lists with IDs from that list. Must be used after subtracting from a gas. Must be used after assert_gas() if assert_gas() was called only to read from the gas. By removing empty gases, processing speed is increased.
get_breath_partial_pressure	Takes the amount of the gas you want to PP as an argument So I don't have to do some hacky switches/defines/magic strings eg: Tox_PP = get_partial_pressure(gas_mixture.toxins) O2_PP = get_partial_pressure(gas_mixture.oxygen)
get_true_breath_pressure	inverse
has_gas	Checks to see if gas amount exists in mixture. Do NOT use this in code where performance matters! It's better to batch calls to garbage_collect(), especially in places where you're checking many gastypes
heat_capacity	joules per kelvin
merge	Merges all air from giver into self. Deletes giver. Returns: 1 if we are mutable, 0 otherwise
parse_gas_string	Copies variables from a particularly formatted string. Returns: 1 if we are mutable, 0 otherwise
pump_gas_to	Mathematical proofs: get_breath_partial_pressure(gas_pp) --> gas_pp/total_moles()breath_pp = pp get_true_breath_pressure(pp) --> gas_pp = pp/breath_pptotal_moles()
react	Performs various reactions such as combustion and fabrication Returns: 1 if any reaction took place; 0 otherwise
release_gas_to	Releases gas from src to output air. This means that it can not transfer air to gas mixture with higher pressure.
remove	Proportionally removes amount of gas from the gas_mixture. Returns: gas_mixture with the gases removed
remove_ratio	Proportionally removes amount of gas from the gas_mixture. Returns: gas_mixture with the gases removed
remove_specific	Removes an amount of a specific gas from the gas_mixture. Returns: gas_mixture with the gas removed
return_pressure	Calculate pressure in kilopascals
return_temperature	Calculate temperature in kelvins
return_visuals	Gets the gas visuals for everything in this mixture
return_volume	Calculate volume in liters
share	Performs air sharing calculations between two gas_mixtures assuming only 1 boundary length Returns: amount of gas exchanged (+ if sharer received)
temperature_share	Performs temperature sharing calculations (via conduction) between two gas_mixtures assuming only 1 boundary length Returns: new temperature of the sharer
thermal_energy	Calculate thermal energy in joules
total_moles	Calculate moles

Var Details

var
analyzer_results
– /list

Used for analyzer feedback - not initialized until its used

var
gc_share
–

Whether to call garbage_collect() on the sharer during shares, used for immutable mixtures

var
reaction_results
– /list

The fire key contains information that might determine the volume of hotspots.

Proc Details

proc
add_gas
(gas_id)

add_gas(gas_id) - similar to assert_gas(), but does not check for an existing gas list for this id. This can clobber existing gases. Used instead of assert_gas() when you know the gas does not exist. Faster than assert_gas().

proc
add_gases
(...)

add_gases(args) - shorthand for calling add_gas() once for each gas_type.

proc
archive
()

Update archived versions of variables. Returns: 1 in all cases

proc
assert_gas
(gas_id)

assert_gas(gas_id) - used to guarantee that the gas list for this id exists in gas_mixture.gases. Must be used before adding to a gas. May be used before reading from a gas.

proc
assert_gases
(...)

assert_gases(args) - shorthand for calling ASSERT_GAS() once for each gas type.

proc
compare
(/datum/gas_mixture/sample)

Compares sample to self to see if within acceptable ranges that group processing may be enabled Returns: a string indicating what check failed, or "" if check passes

proc
copy
()

Creates new, identical gas mixture Returns: duplicate gas mixture

proc
copy_from
(/datum/gas_mixture/sample, partial)

Copies variables from sample, moles multiplicated by partial Returns: 1 if we are mutable, 0 otherwise

proc
copy_from_turf
(/turf/model)

Copies all gas info from the turf into the gas list along with temperature Returns: TRUE if we are mutable, FALSE otherwise

proc
equalize
(/datum/gas_mixture/other)

Distributes the contents of two mixes equally between themselves

proc
garbage_collect
(/list/tocheck)

garbage_collect() - removes any gas list which is empty. If called with a list as an argument, only removes gas lists with IDs from that list. Must be used after subtracting from a gas. Must be used after assert_gas() if assert_gas() was called only to read from the gas. By removing empty gases, processing speed is increased.

proc
get_breath_partial_pressure
(gas_pressure)

Takes the amount of the gas you want to PP as an argument So I don't have to do some hacky switches/defines/magic strings eg: Tox_PP = get_partial_pressure(gas_mixture.toxins) O2_PP = get_partial_pressure(gas_mixture.oxygen)

proc
get_true_breath_pressure
(partial_pressure)

inverse

proc
has_gas
(gas_id, amount)

Checks to see if gas amount exists in mixture. Do NOT use this in code where performance matters! It's better to batch calls to garbage_collect(), especially in places where you're checking many gastypes

proc
heat_capacity
(data)

joules per kelvin

proc
merge
(/datum/gas_mixture/giver)

Merges all air from giver into self. Deletes giver. Returns: 1 if we are mutable, 0 otherwise

proc
parse_gas_string
(gas_string)

Copies variables from a particularly formatted string. Returns: 1 if we are mutable, 0 otherwise

proc
pump_gas_to
(/datum/gas_mixture/output_air, target_pressure, specific_gas)

Mathematical proofs: get_breath_partial_pressure(gas_pp) --> gas_pp/total_moles()breath_pp = pp get_true_breath_pressure(pp) --> gas_pp = pp/breath_pptotal_moles()

10/205 = 2.5 10 = 2.5/520 Pumps gas from src to output_air. Amount depends on target_pressure

proc
react
(/datum/holder)

Performs various reactions such as combustion and fabrication Returns: 1 if any reaction took place; 0 otherwise

proc
release_gas_to
(/datum/gas_mixture/output_air, target_pressure, rate)

Releases gas from src to output air. This means that it can not transfer air to gas mixture with higher pressure.

proc
remove
(amount)

Proportionally removes amount of gas from the gas_mixture. Returns: gas_mixture with the gases removed

proc
remove_ratio
(ratio)

Proportionally removes amount of gas from the gas_mixture. Returns: gas_mixture with the gases removed

proc
remove_specific
(gas_id, amount)

Removes an amount of a specific gas from the gas_mixture. Returns: gas_mixture with the gas removed

proc
return_pressure
()

Calculate pressure in kilopascals

proc
return_temperature
()

Calculate temperature in kelvins

proc
return_visuals
()

Gets the gas visuals for everything in this mixture

proc
return_volume
()

Calculate volume in liters

Performs air sharing calculations between two gas_mixtures assuming only 1 boundary length Returns: amount of gas exchanged (+ if sharer received)

proc
temperature_share
(/datum/gas_mixture/sharer, conduction_coefficient, sharer_temperature, sharer_heat_capacity)

Performs temperature sharing calculations (via conduction) between two gas_mixtures assuming only 1 boundary length Returns: new temperature of the sharer

proc
thermal_energy
()

Calculate thermal energy in joules

proc
total_moles
()

Calculate moles

gas_mixture /datum/gas_mixture

Vars

Procs

Var Details

var analyzer_results – /list

var gc_share –

var reaction_results – /list

Proc Details

proc add_gas(gas_id)

proc add_gases(...)

proc archive()

proc assert_gas(gas_id)

proc assert_gases(...)

proc compare(/datum/gas_mixture/sample)

proc copy()

proc copy_from(/datum/gas_mixture/sample, partial)

proc copy_from_turf(/turf/model)

proc equalize(/datum/gas_mixture/other)

proc garbage_collect(/list/tocheck)

proc get_breath_partial_pressure(gas_pressure)

proc get_true_breath_pressure(partial_pressure)

proc has_gas(gas_id, amount)

proc heat_capacity(data)

proc merge(/datum/gas_mixture/giver)

proc parse_gas_string(gas_string)

proc pump_gas_to(/datum/gas_mixture/output_air, target_pressure, specific_gas)

proc react(/datum/holder)

proc release_gas_to(/datum/gas_mixture/output_air, target_pressure, rate)

proc remove(amount)

proc remove_ratio(ratio)

proc remove_specific(gas_id, amount)

proc return_pressure()

proc return_temperature()

proc return_visuals()

proc return_volume()

proc share(/datum/gas_mixture/sharer, atmos_adjacent_turfs)

proc temperature_share(/datum/gas_mixture/sharer, conduction_coefficient, sharer_temperature, sharer_heat_capacity)

proc thermal_energy()

proc total_moles()