atmospherics

Vars
can_unwrench	Check if the object can be unwrenched
cap_overlay	Cap overlay that is being added to turf's `vis_contents`, `null` if pipe was never hidden or has no valid connections
construction_type	The path of the pipe/device that will spawn after unwrenching it (such as pipe fittings)
device_type	The type of the device (UNARY, BINARY, TRINARY, QUATERNARY)
has_cap_visuals	Whether it will generate cap sprites when hidden
hide	This only works on pipes, because they have 1000 subtypes which need to be visible and invisible under tiles, so we track this here
init_processing	If we should init and immediately start processing
initialize_directions	Bitflag of the initialized directions (NORTH \| SOUTH \| EAST \| WEST)
nodes	The lists of nodes that a pipe/device has, depends on the device_type var (from 1 to 4)
on	Check if the device should be on or off (mostly used in processing for machines)
override_naming	keeps the name of the object from being overridden if it's vareditted.
paintable	Whether it can be painted
pipe_color	The color of the pipe
pipe_flags	The flags of the pipe/component (PIPING_ALL_LAYER \| PIPING_ONE_PER_TURF \| PIPING_DEFAULT_LAYER_ONLY \| PIPING_CARDINAL_AUTONORMALIZE)
pipe_state	icon_state as a pipe item
pipe_vision_img	The image of the pipe/device used for ventcrawling
piping_layer	What layer the pipe is in (from 1 to 5, default 3)
rebuilding	Is the thing being rebuilt by SSair or not. Prevents list bloat
vent_movement	The bitflag that's being checked on ventcrawling. Default is to allow ventcrawling and seeing pipes.
Procs
atmos_init	Initialize for atmos devices
can_be_node	Check if a node can actually exists by connecting to another machine called on atmos_init() Arguments:
can_see_pipes	Used for certain children of obj/machinery/atmospherics to not show pipe vision when mob is inside it.
can_unwrench	Getter for can_unwrench
connection_check	Check the connection between two nodes
destroy_network	Called by the machinery disconnect(), custom for each type
disconnect	Disconnects the nodes
find_connecting	Find a connecting /obj/machinery/atmospherics in specified direction, called by relaymove() used by ventcrawling mobs to check if they can move inside a pipe in a specific direction Arguments:
get_init_directions	Getter of initial directions
get_node_connects	Getter for node_connects
get_pipe_image	Getter for piping layer shifted, pipe colored overlays
get_rebuild_targets	Returns a list of new pipelines that need to be built up
is_connectable	check if the piping layer and color are the same on both sides (grey can connect to all colors) returns TRUE or FALSE if the connection is possible or not Arguments:
normalize_cardinal_directions	Setter for device direction
nullify_node	Called on destroy(mostly deconstruction) and when moving nodes around, disconnect the nodes from the network Arguments:
on_deconstruction	Pipe deconstruction
on_hide	Signal handler. Updates both our pipe cap visuals and those of adjacent nodes. We update adjacent nodes as their pipe caps are based partially on our state, so they need updating as well.
paint	Called by the RPD.dm pre_attack() Arguments:
pipeline_expansion	Called on construction and when expanding the datum_pipeline, returns the nodes of the device
portable_device_connected	Return TRUE if there is device connected to portables_connector
rebuild_pipes	This should only be called by SSair as part of the rebuild queue. Handles rebuilding pipelines after init or they've been changed.
replace_pipenet	Replaces the connection to the old_pipenet with the new_pipenet
return_pipenet	Called by add_member() in datum_pipeline.dm, returns the parent network the device is connected to
return_pipenet_airs	Called by add_machinery_member() in datum_pipeline.dm, returns a list of gas_mixtures and assigns them into other_airs (by addMachineryMember) to allow pressure redistribution for the machineries.
return_pipenets	Getter of a list of pipenets
set_init_directions	Set the initial directions of the device (NORTH \|\| SOUTH \|\| EAST \|\| WEST), called on New()
set_pipe_color	Setter for pipe color, so we can ensure it's all uniform and save cpu time
set_pipenet	Called by build_pipeline() and add_member() in datum_pipeline.dm, set the network the device is connected to, to the datum pipeline it has reference
set_piping_layer	setter for pipe layers
setup_hiding	Sets up our pipe hiding logic, consolidated in one place so subtypes may override it. This lets subtypes implement their own hiding logic without needing to worry about conflicts with the parent hiding logic.
shuttleRotate	Machine rotate procs
unsafe_pressure_release	Pipe pressure release calculations
update_cap_visuals	Handles cap overlay addition and removal, won't do anything if `has_cap_visuals` is set to `FALSE`
update_layer	Update the layer in which the pipe/device is in, that way pipes have consistent layer depending on piping_layer

Var Details

var
can_unwrench
–

Check if the object can be unwrenched

var
cap_overlay
– /obj/effect/overlay/cap_visual

Cap overlay that is being added to turf's vis_contents, null if pipe was never hidden or has no valid connections

var
construction_type
–

The path of the pipe/device that will spawn after unwrenching it (such as pipe fittings)

var
device_type
–

The type of the device (UNARY, BINARY, TRINARY, QUATERNARY)

var
has_cap_visuals
–

Whether it will generate cap sprites when hidden

var
hide
–

This only works on pipes, because they have 1000 subtypes which need to be visible and invisible under tiles, so we track this here

var
init_processing
–

If we should init and immediately start processing

var
initialize_directions
–

Bitflag of the initialized directions (NORTH | SOUTH | EAST | WEST)

var
nodes
– /list/obj/machinery/atmospherics

The lists of nodes that a pipe/device has, depends on the device_type var (from 1 to 4)

var
on
–

Check if the device should be on or off (mostly used in processing for machines)

var
override_naming
–

keeps the name of the object from being overridden if it's vareditted.

var
paintable
–

Whether it can be painted

var
pipe_color
–

The color of the pipe

var
pipe_flags
–

The flags of the pipe/component (PIPING_ALL_LAYER | PIPING_ONE_PER_TURF | PIPING_DEFAULT_LAYER_ONLY | PIPING_CARDINAL_AUTONORMALIZE)

var
pipe_state
–

icon_state as a pipe item

var
pipe_vision_img
– /image

The image of the pipe/device used for ventcrawling

var
piping_layer
–

What layer the pipe is in (from 1 to 5, default 3)

var
rebuilding
–

Is the thing being rebuilt by SSair or not. Prevents list bloat

var
vent_movement
–

The bitflag that's being checked on ventcrawling. Default is to allow ventcrawling and seeing pipes.

Proc Details

proc
atmos_init
(/list/node_connects)

Initialize for atmos devices

initialize the nodes for each pipe/device, this is called just after the air controller sets up turfs Arguments:

list/node_connects - a list of the nodes on the device that can make a connection to other machines

proc
can_be_node
(/obj/machinery/atmospherics/target)

Check if a node can actually exists by connecting to another machine called on atmos_init() Arguments:

obj/machinery/atmospherics/target - the machine we are connecting to

proc
can_see_pipes
()

Used for certain children of obj/machinery/atmospherics to not show pipe vision when mob is inside it.

proc
can_unwrench
(/mob/user)

Getter for can_unwrench

Called by wrench_act() to check if the device can be unwrenched, each device override this with custom code (like if on/operating can't unwrench) Arguments:

mob/user - the mob doing the act

proc
connection_check
(/obj/machinery/atmospherics/target, given_layer)

Check the connection between two nodes

Check if our machine and the target machine are connectable by both calling isConnectable and by checking that the directions and piping_layer are compatible called by can_be_node() (for building a network) and find_connecting() (for ventcrawling) Arguments:

obj/machinery/atmospherics/target - the machinery we want to connect to
given_layer - the piping_layer we are checking

proc
destroy_network
()

Called by the machinery disconnect(), custom for each type

proc
disconnect
(/obj/machinery/atmospherics/reference)

Disconnects the nodes

Called by nullify_node(), it disconnects two nodes by removing the reference id from the node itself that called this proc Arguments:

obj/machinery/atmospherics/reference - the machinery we are removing from the node connection

proc
find_connecting
(direction, prompted_layer)

Find a connecting /obj/machinery/atmospherics in specified direction, called by relaymove() used by ventcrawling mobs to check if they can move inside a pipe in a specific direction Arguments:

direction - the direction we are checking against
prompted_layer - the piping_layer we are inside

proc
get_init_directions
()

Getter of initial directions

proc
get_node_connects
()

Getter for node_connects

Return a list of the nodes that can connect to other machines, get called by atmos_init()

proc
get_pipe_image
(iconfile, iconstate, direction, color, piping_layer, trinary)

Getter for piping layer shifted, pipe colored overlays

Creates the image for the pipe underlay that all components use, called by get_pipe_underlay() in components_base.dm Arguments:

iconfile - path of the iconstate we are using (ex: 'icons/obj/machines/atmospherics/thermomachine.dmi')
iconstate - the image we are using inside the file
direction - the direction of our device
color - the color (in hex value, like #559900) that the pipe should have
piping_layer - the piping_layer the device is in, used inside PIPING_LAYER_SHIFT
trinary - if TRUE we also use PIPING_FORWARD_SHIFT on layer 1 and 5 for trinary devices (filters and mixers)

proc
get_rebuild_targets
()

Returns a list of new pipelines that need to be built up

proc
is_connectable
(/obj/machinery/atmospherics/target, given_layer)

check if the piping layer and color are the same on both sides (grey can connect to all colors) returns TRUE or FALSE if the connection is possible or not Arguments:

obj/machinery/atmospherics/target - the machinery we want to connect to
given_layer - the piping_layer we are connecting to

proc
normalize_cardinal_directions
()

Setter for device direction

Set the direction to either SOUTH or WEST if the pipe_flag is set to PIPING_CARDINAL_AUTONORMALIZE, called in New(), used mostly by layer manifolds

proc
nullify_node
(i)

Called on destroy(mostly deconstruction) and when moving nodes around, disconnect the nodes from the network Arguments:

i - is the current iteration of the node, based on the device_type (from 1 to 4)

↑
on_deconstruction
(disassembled)

Pipe deconstruction

Called by wrench_act(), create a pipe fitting and remove the pipe

proc
on_hide
(/datum/source)

Signal handler. Updates both our pipe cap visuals and those of adjacent nodes. We update adjacent nodes as their pipe caps are based partially on our state, so they need updating as well.

proc
paint
(paint_color)

Called by the RPD.dm pre_attack() Arguments:

paint_color - color that the pipe will be painted in (colors in hex like #4f4f4f)

proc
pipeline_expansion
()

Called on construction and when expanding the datum_pipeline, returns the nodes of the device

proc
portable_device_connected
(node)

Return TRUE if there is device connected to portables_connector

proc
rebuild_pipes
()

This should only be called by SSair as part of the rebuild queue. Handles rebuilding pipelines after init or they've been changed.

proc
replace_pipenet
(/datum/pipeline/old_pipenet, /datum/pipeline/new_pipenet)

Replaces the connection to the old_pipenet with the new_pipenet

proc
return_pipenet
()

Called by add_member() in datum_pipeline.dm, returns the parent network the device is connected to

proc
return_pipenet_airs
()

Called by add_machinery_member() in datum_pipeline.dm, returns a list of gas_mixtures and assigns them into other_airs (by addMachineryMember) to allow pressure redistribution for the machineries.

proc
return_pipenets
()

Getter of a list of pipenets

called in relaymove() to create the image for vent crawling

proc
set_init_directions
(init_dir)

Set the initial directions of the device (NORTH || SOUTH || EAST || WEST), called on New()

proc
set_pipe_color
(pipe_colour)

Setter for pipe color, so we can ensure it's all uniform and save cpu time

proc
set_pipenet
()

Called by build_pipeline() and add_member() in datum_pipeline.dm, set the network the device is connected to, to the datum pipeline it has reference

proc
set_piping_layer
(new_layer)

setter for pipe layers

Set the layer of the pipe that the device has to a new_layer Arguments:

new_layer - the layer at which we want the piping_layer to be (1 to 5)

proc
setup_hiding
()

Sets up our pipe hiding logic, consolidated in one place so subtypes may override it. This lets subtypes implement their own hiding logic without needing to worry about conflicts with the parent hiding logic.

↑
shuttleRotate
(rotation, params)

Machine rotate procs

proc
unsafe_pressure_release
(/mob/user, pressures)

Pipe pressure release calculations

Throws the user when they unwrench a pipe with a major difference between the internal and environmental pressure. Called by wrench_act() before deconstruct() Arguments:

mob_user - the mob doing the act
pressures - it can be passed on from wrench_act(), it's the pressure difference between the environment pressure and the pipe internal pressure

proc
update_cap_visuals
()

Handles cap overlay addition and removal, won't do anything if has_cap_visuals is set to FALSE

proc
update_layer
()

Update the layer in which the pipe/device is in, that way pipes have consistent layer depending on piping_layer

atmospherics /obj/machinery/atmospherics

Vars

Procs

Var Details

var can_unwrench –

var cap_overlay – /obj/effect/overlay/cap_visual

var construction_type –

var device_type –

var has_cap_visuals –

var hide –

var init_processing –

var initialize_directions –

var nodes – /list/obj/machinery/atmospherics

var on –

var override_naming –

var paintable –

var pipe_color –

var pipe_flags –

var pipe_state –

var pipe_vision_img – /image

var piping_layer –

var rebuilding –

var vent_movement –

Proc Details

proc atmos_init(/list/node_connects)

proc can_be_node(/obj/machinery/atmospherics/target)

proc can_see_pipes()

proc can_unwrench(/mob/user)

proc connection_check(/obj/machinery/atmospherics/target, given_layer)

proc destroy_network()

proc disconnect(/obj/machinery/atmospherics/reference)

proc find_connecting(direction, prompted_layer)

proc get_init_directions()

proc get_node_connects()

proc get_pipe_image(iconfile, iconstate, direction, color, piping_layer, trinary)

proc get_rebuild_targets()

proc is_connectable(/obj/machinery/atmospherics/target, given_layer)

proc normalize_cardinal_directions()

proc nullify_node(i)

↑on_deconstruction(disassembled)

proc on_hide(/datum/source)

proc paint(paint_color)

proc pipeline_expansion()

proc portable_device_connected(node)

proc rebuild_pipes()

proc replace_pipenet(/datum/pipeline/old_pipenet, /datum/pipeline/new_pipenet)

proc return_pipenet()

proc return_pipenet_airs()

proc return_pipenets()

proc set_init_directions(init_dir)

proc set_pipe_color(pipe_colour)

proc set_pipenet()

proc set_piping_layer(new_layer)

proc setup_hiding()

↑shuttleRotate(rotation, params)

proc unsafe_pressure_release(/mob/user, pressures)

proc update_cap_visuals()

proc update_layer()