atom

Vars
affecting_heat_sources	Used by exterior turfs to determine the warming effect of campfires and such.
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.
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.
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.
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
CanZPass	`direction` is the direction the atom is trying to leave by.
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.
get_diggable_resources	Return an assoc list of resource item type to a base and a random component ex. return list(/obj/item/stack/material/ore/handful/sand = list(3, 2))
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
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
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
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
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
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
CanZPass
(/atom/A, direction, check_neighbor_canzpass)

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

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
get_diggable_resources
()

Return an assoc list of resource item type to a base and a random component ex. return list(/obj/item/stack/material/ore/handful/sand = list(3, 2))

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
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 air – /datum/gas_mixture

var airflow_open_directions –

var ambience_queued –

var can_inherit_air –

var external_atmosphere_participation –

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 z_appearance –

var z_eventually_space – /tmp

var z_queued – /tmp

var zone – /zone

var zone_membership_candidate –