airlock_pump

The pump looks up for the airlocks automatically based on airlock_pump_distance_limit and airlock_group_distance_limit values. When placed, the dir value (direction where the pipes are coming from) is considered as a direction towards the station (internal). The opposite direction is external. The airlock then tries to find airlocks or walls towards these directions until airlock_pump_distance_limit number of tiles reached. When it finds a valid object, then it tries to find airlocks, in directions perpendicular to the found tiles. And then adds them to the corresponding group (external/internal) until airlock_group_distance_limit number of tiles reached

Example scheme of a valid configuration: A-----W A-----A W--P--A W-----W A-----W

Where: A - airlocks W - walls P - pump A vent, scrubber and a sensor in a single device meant specifically for cycling airlocks. Ideal for airlocks of up to 3x3 tiles in size to avoid wind and timing out.

Vars
adjacent_turfs	List of the turfs adjacent to the pump for faster cycling and avoiding wind
airlock_group_distance_limit	Max distance between the central airlock and the side airlocks in a group
airlock_pump_distance_limit	Max distance between the airlock and the pump. Used to set up cycling.
airlocks_animating	Airlocks currently animating
allowed_pressure_error	Allowed error in pressure checks
cycle_pressure_target	Target pressure for the current cycle
cycle_start_time	The start time of the current cycle to calculate cycle duration
cycle_timeout	Max duration of cycle, after which the pump will unlock the airlocks with a warning
cycling_set_up	Whether both airlocks are specified and cycling is available
docked_side_pressure	Which pressure holds docked vessel\station for override of external_pressure_target
external_airlocks	Space-facing airlocks used in cycling
external_pressure_target	Target pressure for depressurization cycle
internal_airlocks	Station-facing airlocks used in cycling
internal_pressure_target	Target pressure for pressurization cycle
is_cycling_audible	Whether the airlocks comment the cycling details to the chat
min_distro_pressure	Minimal distro pressure to start cycling
open_airlock_on_cycle	Whether the pump opens the airlocks up instead of simpy unbolting them on cycle
pump_direction	Indicates that the direction of the pump, if ATMOS_DIRECTION_SIPHONING is siphoning, if ATMOS_DIRECTION_RELEASING is releasing
valid_airlock_typepath	Type of airlocks required for automatic cycling setup. To avoid hacking bridge doors. Ignored for mapspawn pump.
volume_rate	Rate of the pump to remove gases from the air
Procs
airlock_act	Proc for triggering cycle by clicking on a bolted airlock that has a pump assigned
break_all_links	Break the cycling setup
check_turfs	Update adjacent_turfs with atmospherically adjacent tiles
fill_tile	Fill a tile with air from the distro node
find_density	Get the turf of the first found airlock or an airtight structure (walls) within the allowed range
get_adjacent_airlocks	Find airlocks adjacent to the central one, lined up along the provided directions
is_valid_airlock	Whether the passed airlock can be linked with
set_links	Find airlocks and link up with them
siphon_tile	Siphon air from the tile to the waste node within the volume rate limit
start_cycle	Start decompression or pressurization cycle depending on the passed direction
stop_cycle	Complete/Abort cycle with the passed message
unlink_airlock	Find airlocks and link up with them

Var Details

var
adjacent_turfs
– /list/turf

List of the turfs adjacent to the pump for faster cycling and avoiding wind

var
airlock_group_distance_limit
–

Max distance between the central airlock and the side airlocks in a group

var
airlock_pump_distance_limit
–

Max distance between the airlock and the pump. Used to set up cycling.

var
airlocks_animating
–

Airlocks currently animating

var
allowed_pressure_error
–

Allowed error in pressure checks

var
cycle_pressure_target
–

Target pressure for the current cycle

var
cycle_start_time
–

The start time of the current cycle to calculate cycle duration

var
cycle_timeout
–

Max duration of cycle, after which the pump will unlock the airlocks with a warning

var
cycling_set_up
–

Whether both airlocks are specified and cycling is available

var
docked_side_pressure
–

Which pressure holds docked vessel\station for override of external_pressure_target

var
external_airlocks
– /list/obj/machinery/door/airlock

Space-facing airlocks used in cycling

var
external_pressure_target
–

Target pressure for depressurization cycle

var
internal_airlocks
– /list/obj/machinery/door/airlock

Station-facing airlocks used in cycling

var
internal_pressure_target
–

Target pressure for pressurization cycle

var
is_cycling_audible
–

Whether the airlocks comment the cycling details to the chat

var
min_distro_pressure
–

Minimal distro pressure to start cycling

var
open_airlock_on_cycle
–

Whether the pump opens the airlocks up instead of simpy unbolting them on cycle

var
pump_direction
–

Indicates that the direction of the pump, if ATMOS_DIRECTION_SIPHONING is siphoning, if ATMOS_DIRECTION_RELEASING is releasing

var
valid_airlock_typepath
–

Type of airlocks required for automatic cycling setup. To avoid hacking bridge doors. Ignored for mapspawn pump.

var
volume_rate
–

Rate of the pump to remove gases from the air

Proc Details

proc
airlock_act
(/obj/machinery/door/airlock/airlock)

Proc for triggering cycle by clicking on a bolted airlock that has a pump assigned

proc
break_all_links
()

Break the cycling setup

proc
check_turfs
()

Update adjacent_turfs with atmospherically adjacent tiles

proc
fill_tile
(/turf/tile, moles, pressure_delta)

Fill a tile with air from the distro node

proc
find_density
(/turf/origin, direction, max_distance)

Get the turf of the first found airlock or an airtight structure (walls) within the allowed range

proc
get_adjacent_airlocks
(origin_turf, directions)

Find airlocks adjacent to the central one, lined up along the provided directions

proc
is_valid_airlock
(/obj/machinery/door/airlock/airlock)

Whether the passed airlock can be linked with

proc
set_links
()

Find airlocks and link up with them

proc
siphon_tile
(/turf/tile)

Siphon air from the tile to the waste node within the volume rate limit

proc
start_cycle
(cycle_direction, /obj/machinery/door/airlock/source_airlock)

Start decompression or pressurization cycle depending on the passed direction

proc
stop_cycle
(message, unbolt_only)

Complete/Abort cycle with the passed message

proc
unlink_airlock
(airlock)

Find airlocks and link up with them

airlock_pump /obj/machinery/atmospherics/components/unary/airlock_pump

Vars

Procs

Var Details

var adjacent_turfs – /list/turf

var airlock_group_distance_limit –

var airlock_pump_distance_limit –

var airlocks_animating –

var allowed_pressure_error –

var cycle_pressure_target –

var cycle_start_time –

var cycle_timeout –

var cycling_set_up –

var docked_side_pressure –

var external_airlocks – /list/obj/machinery/door/airlock

var external_pressure_target –

var internal_airlocks – /list/obj/machinery/door/airlock

var internal_pressure_target –

var is_cycling_audible –

var min_distro_pressure –

var open_airlock_on_cycle –

var pump_direction –

var valid_airlock_typepath –

var volume_rate –

Proc Details

proc airlock_act(/obj/machinery/door/airlock/airlock)

proc break_all_links()

proc check_turfs()

proc fill_tile(/turf/tile, moles, pressure_delta)

proc find_density(/turf/origin, direction, max_distance)

proc get_adjacent_airlocks(origin_turf, directions)

proc is_valid_airlock(/obj/machinery/door/airlock/airlock)

proc set_links()

proc siphon_tile(/turf/tile)

proc start_cycle(cycle_direction, /obj/machinery/door/airlock/source_airlock)

proc stop_cycle(message, unbolt_only)

proc unlink_airlock(airlock)

airlock_pump
/obj/machinery/atmospherics/components/unary/airlock_pump

var
adjacent_turfs
– /list/turf

var
airlock_group_distance_limit
–

var
airlock_pump_distance_limit
–

var
airlocks_animating
–

var
allowed_pressure_error
–

var
cycle_pressure_target
–

var
cycle_start_time
–

var
cycle_timeout
–

var
cycling_set_up
–

var
docked_side_pressure
–

var
external_airlocks
– /list/obj/machinery/door/airlock

var
external_pressure_target
–

var
internal_airlocks
– /list/obj/machinery/door/airlock

var
internal_pressure_target
–

var
is_cycling_audible
–

var
min_distro_pressure
–

var
open_airlock_on_cycle
–

var
pump_direction
–

var
valid_airlock_typepath
–

var
volume_rate
–

proc
airlock_act
(/obj/machinery/door/airlock/airlock)

proc
break_all_links
()

proc
check_turfs
()

proc
fill_tile
(/turf/tile, moles, pressure_delta)

proc
find_density
(/turf/origin, direction, max_distance)

proc
get_adjacent_airlocks
(origin_turf, directions)

proc
is_valid_airlock
(/obj/machinery/door/airlock/airlock)

proc
set_links
()

proc
siphon_tile
(/turf/tile)

proc
start_cycle
(cycle_direction, /obj/machinery/door/airlock/source_airlock)

proc
stop_cycle
(message, unbolt_only)

proc
unlink_airlock
(airlock)