atom

Vars
affecting_heat_sources	Used by exterior turfs to determine the warming effect of campfires and such.
affecting_lights	List of light sources affecting this turf.
air	The cached air mixture of a turf. Never directly access, use `return_air()`.
airflow_open_directions	All directions in which a turf that can contain air is present.
ambience_queued	Whether this turf has been queued for an ambient lighting update.
ambient_has_indirect	If this is TRUE, an above turf's ambient light is affecting this turf.
ambient_light	If non-null, a hex RGB light color that should be applied to this turf.
ambient_light_multiplier	The power of the above is multiplied by this. Setting too high may drown out normal lights on the same turf.
blocks_air	Does this turf contain air/let air through?
can_inherit_air	Whether this tile is willing to copy air from a previous tile through ChangeTurf, transfer_turf_properties etc.
external_atmosphere_participation	Will participate in external atmosphere simulation if the turf is outside and no zone is set.
has_opaque_atom	Not to be confused with opacity, this will be TRUE if there's any opaque atom on the tile.
initial_gas	Either a mapping of material decls to mol amounts, or a reserved initial gas define like GAS_STANDARD_AIRMIX.
lighting_overlay	Our lighting overlay, used to apply multiplicative lighting to the tile and its contents.
mimic_above_copy	If this is a delegate (non-overwrite) Z-turf with a z-turf above, this is the delegate copy that's copying us.
mimic_proxy	If we're a non-overwrite z-turf, this holds the appearance of the bottom-most Z-turf in the z-stack.
mimic_underlay	If we're at the bottom of the stack, a proxy used to fake a below space turf.
needs_air_update	Is this turf queued in the TURFS cycle of SSair?
shadower	Overlay used to multiply color of all OO overlays at once.
supporting_platform	Floorlike structures like catwalks. Updated/retrieved by get_supporting_platform()
z_appearance	Use this appearance for our appearance instead of `appearance`. If ZM_OVERRIDE is set, only this will be visible, no movables will be copied.
z_eventually_space	If this Z-turf leads to space, uninterrupted.
z_queued	How many times this turf is currently queued - multiple queue occurrences are allowed to ensure update consistency.
zone	The turf's current zone.
zone_membership_candidate	Will participate in ZAS, join zones, etc.
Procs
AddTracks	Creates a new /obj/effect/decal/cleanable/blood/tracks instance of a given type, or merges it with an existing (not-yet-cleaned) one that matches typepath and chemical. typepath is a type, not an instance new_chemical is optional argument for things like muddy footprints, where typepath isn't enough
CanZPass	`direction` is the direction the atom is trying to leave by.
can_show_coating_footprints	Contaminant may be the chemical type of the footprint being provided, or null if we just want to know if we support footprints, at all, ever.
cannot_build_cable	*Whether we can place a cable here
cleanup_zmimic	Cleans up Z-mimic objects for this turf. You shouldn't call this directly 99% of the time.
disable_zmimic	Disables Z-mimic for a turf.
enable_zmimic	Enables Z-mimic for a turf that didn't already have it enabled.
force_update_lights	Forces a lighting update. Reconsider lights is preferred when possible.
get_avg_color	Returns the average color of this tile. Roughly corresponds to the color of a single old-style lighting overlay.
get_diggable_resources	Return an assoc list of resource item type to a metadata list containing base amount, random component, and material override ex. return list(/obj/item/stack/material/ore/handful/sand = list("amount" = 3, "variance" = 2, "material" = /decl/material/foo))
get_lumcount	Returns a lumcount (average intensity of color channels) scaled between minlum and maxlum.
recalc_atom_opacity	Can't think of a good name, this proc will recalculate the has_opaque_atom variable.
reconsider_lights	Causes any affecting light sources to be queued for a visibility update, for example a door got opened.
setup_zmimic	Sets up Z-mimic for this turf. You shouldn't call this directly 99% of the time.
try_build_cable	Place a cable if possible, if not warn the user appropriately
update_air_properties	Turf Vars
update_external_atmos_participation	Updates turf participation in ZAS according to outside status and atmosphere participation bools. Must be called whenever any of those values may change.
why_cannot_build_cable	Sends a message to the user explaining why they can't build a cable here

Var Details

var
affecting_heat_sources
– /list

Used by exterior turfs to determine the warming effect of campfires and such.

var
affecting_lights
– /tmp/list/datum/light_source

List of light sources affecting this turf.

var
air
– /datum/gas_mixture

The cached air mixture of a turf. Never directly access, use return_air().

var
airflow_open_directions
–

All directions in which a turf that can contain air is present.

var
ambience_queued
–

Whether this turf has been queued for an ambient lighting update.

var
ambient_has_indirect
– /tmp

If this is TRUE, an above turf's ambient light is affecting this turf.

var
ambient_light
–

If non-null, a hex RGB light color that should be applied to this turf.

var
ambient_light_multiplier
–

The power of the above is multiplied by this. Setting too high may drown out normal lights on the same turf.

var
blocks_air
–

Does this turf contain air/let air through?

var
can_inherit_air
–

Whether this tile is willing to copy air from a previous tile through ChangeTurf, transfer_turf_properties etc.

var
external_atmosphere_participation
–

Will participate in external atmosphere simulation if the turf is outside and no zone is set.

var
has_opaque_atom
– /tmp

Not to be confused with opacity, this will be TRUE if there's any opaque atom on the tile.

var
initial_gas
– /list

Either a mapping of material decls to mol amounts, or a reserved initial gas define like GAS_STANDARD_AIRMIX.

var
lighting_overlay
– /tmp/atom/movable/lighting_overlay

Our lighting overlay, used to apply multiplicative lighting to the tile and its contents.

var
mimic_above_copy
– /tmp/atom/movable/openspace/turf_mimic

If this is a delegate (non-overwrite) Z-turf with a z-turf above, this is the delegate copy that's copying us.

var
mimic_proxy
– /tmp/atom/movable/openspace/turf_proxy

If we're a non-overwrite z-turf, this holds the appearance of the bottom-most Z-turf in the z-stack.

var
mimic_underlay
– /tmp/atom/movable/openspace/turf_proxy

If we're at the bottom of the stack, a proxy used to fake a below space turf.

var
needs_air_update
–

Is this turf queued in the TURFS cycle of SSair?

var
shadower
– /tmp/atom/movable/openspace/multiplier

Overlay used to multiply color of all OO overlays at once.

var
supporting_platform
– /obj/structure

Floorlike structures like catwalks. Updated/retrieved by get_supporting_platform()

var
z_appearance
–

Use this appearance for our appearance instead of appearance. If ZM_OVERRIDE is set, only this will be visible, no movables will be copied.

var
z_eventually_space
– /tmp

If this Z-turf leads to space, uninterrupted.

var
z_queued
– /tmp

How many times this turf is currently queued - multiple queue occurrences are allowed to ensure update consistency.

var
zone
– /zone

The turf's current zone.

var
zone_membership_candidate
–

Will participate in ZAS, join zones, etc.

Proc Details

proc
AddTracks
(/obj/effect/decal/cleanable/blood/tracks/typepath, bloodDNA, comingdir, goingdir, bloodcolor, new_chemical)

Creates a new /obj/effect/decal/cleanable/blood/tracks instance of a given type, or merges it with an existing (not-yet-cleaned) one that matches typepath and chemical. typepath is a type, not an instance new_chemical is optional argument for things like muddy footprints, where typepath isn't enough

proc
CanZPass
(/atom/A, direction, check_neighbor_canzpass)

direction is the direction the atom is trying to leave by.

proc
can_show_coating_footprints
(/decl/material/contaminant)

Contaminant may be the chemical type of the footprint being provided, or null if we just want to know if we support footprints, at all, ever.

proc
cannot_build_cable
()

*Whether we can place a cable here

If you cannot build a cable will return an error code explaining why you cannot.

proc
cleanup_zmimic
()

Cleans up Z-mimic objects for this turf. You shouldn't call this directly 99% of the time.

proc
disable_zmimic
()

Disables Z-mimic for a turf.

proc
enable_zmimic
(additional_flags)

Enables Z-mimic for a turf that didn't already have it enabled.

proc
force_update_lights
()

Forces a lighting update. Reconsider lights is preferred when possible.

proc
get_avg_color
()

Returns the average color of this tile. Roughly corresponds to the color of a single old-style lighting overlay.

proc
get_diggable_resources
()

Return an assoc list of resource item type to a metadata list containing base amount, random component, and material override ex. return list(/obj/item/stack/material/ore/handful/sand = list("amount" = 3, "variance" = 2, "material" = /decl/material/foo))

proc
get_lumcount
(minlum, maxlum)

Returns a lumcount (average intensity of color channels) scaled between minlum and maxlum.

proc
recalc_atom_opacity
()

Can't think of a good name, this proc will recalculate the has_opaque_atom variable.

proc
reconsider_lights
()

Causes any affecting light sources to be queued for a visibility update, for example a door got opened.

proc
setup_zmimic
(mapload)

Sets up Z-mimic for this turf. You shouldn't call this directly 99% of the time.

proc
try_build_cable
(/obj/item/stack/cable_coil/C, /mob/user)

Place a cable if possible, if not warn the user appropriately

proc
update_air_properties
()

Turf Vars

proc
update_external_atmos_participation
()

Updates turf participation in ZAS according to outside status and atmosphere participation bools. Must be called whenever any of those values may change.

proc
why_cannot_build_cable
(/mob/user, cable_error)

Sends a message to the user explaining why they can't build a cable here

turf /turf inherits /atom

Vars

Procs

Var Details

var affecting_heat_sources – /list

var affecting_lights – /tmp/list/datum/light_source

var air – /datum/gas_mixture

var airflow_open_directions –

var ambience_queued –

var ambient_has_indirect – /tmp

var ambient_light –

var ambient_light_multiplier –

var blocks_air –

var can_inherit_air –

var external_atmosphere_participation –

var has_opaque_atom – /tmp

var initial_gas – /list

var lighting_overlay – /tmp/atom/movable/lighting_overlay

var mimic_above_copy – /tmp/atom/movable/openspace/turf_mimic

var mimic_proxy – /tmp/atom/movable/openspace/turf_proxy

var mimic_underlay – /tmp/atom/movable/openspace/turf_proxy

var needs_air_update –

var shadower – /tmp/atom/movable/openspace/multiplier

var supporting_platform – /obj/structure

var z_appearance –

var z_eventually_space – /tmp

var z_queued – /tmp

var zone – /zone

var zone_membership_candidate –