atom

Vars
above	Reference to any open turf that might be above us to speed up atom Entered() updates.
ambient_active	Do we have non-zero ambient light? Use [TURF_IS_AMBIENT_LIT] instead of reading this directly.
ao_overlays	Current ambient occlusion overlays. Tracked so we can reverse them without dropping all priority overlays.
dangerous_objects	List of 'dangerous' objs that the turf holds that can cause something bad to happen when stepped on, used for AI mobs.
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.
shadower	Overlay used to multiply color of all OO overlays at once.
turf_fire	Reference to the turf fire on the turf
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_membership_candidate	Will participate in ZAS, join zones, etc.
Procs
AdjacentQuick	Quick adjacency (to turf): If you are in the same turf, always true If you are not adjacent, then false
Adjacent_free_dir	Similar to Adjacent, but checks if the path FROM src in an orthogonal direction THROUGH intermediate TO destination is free without considering src turf
ClickCross	This checks if you there is uninterrupted airspace between that turf and this one. This is defined as any dense ATOM_FLAG_CHECKS_BORDER object, or any dense object without throwpass. The border_only flag allows you to not objects (for source and destination squares)
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.
is_safe_to_enter	Returns false if stepping into a tile would cause harm (e.g. open space while unable to fly, water tile while a slime, lava, etc).
register_dangerous_object	Tells the turf that it currently contains something that automated movement should consider if planning to enter the tile. This uses lazy list macros to reduce memory footprint since for 99% of turfs the list would've been empty anyway.
setup_zmimic	Sets up Z-mimic for this turf. You shouldn't call this directly 99% of the time.
unregister_dangerous_object	Similar to `register_dangerous_object()`, for when the dangerous object stops being dangerous/gets deleted/moved/etc.

Var Details

var
above
– /turf

Reference to any open turf that might be above us to speed up atom Entered() updates.

var
ambient_active
–

Do we have non-zero ambient light? Use [TURF_IS_AMBIENT_LIT] instead of reading this directly.

var
ao_overlays
– /list

Current ambient occlusion overlays. Tracked so we can reverse them without dropping all priority overlays.

var
dangerous_objects
– /list

List of 'dangerous' objs that the turf holds that can cause something bad to happen when stepped on, used for AI mobs.

var
external_atmosphere_participation
–

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

var
mimic_above_copy
– /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
– /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
– /atom/movable/openspace/turf_proxy

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

var
shadower
– /atom/movable/openspace/multiplier

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

var
turf_fire
– /obj/turf_fire

Reference to the turf fire on the turf

var
z_eventually_space
–

If this Z-turf leads to space, uninterrupted.

var
z_queued
–

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

var
zone_membership_candidate
–

Will participate in ZAS, join zones, etc.

Proc Details

proc
AdjacentQuick
(/atom/neighbor, /atom/target)

Quick adjacency (to turf): If you are in the same turf, always true If you are not adjacent, then false

proc
Adjacent_free_dir
(/atom/destination, path_dir)

Similar to Adjacent, but checks if the path FROM src in an orthogonal direction THROUGH intermediate TO destination is free without considering src turf

proc
ClickCross
(target_dir, border_only, /atom/target_atom)

This checks if you there is uninterrupted airspace between that turf and this one. This is defined as any dense ATOM_FLAG_CHECKS_BORDER object, or any dense object without throwpass. The border_only flag allows you to not objects (for source and destination squares)

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
is_safe_to_enter
(/mob/living/L)

Returns false if stepping into a tile would cause harm (e.g. open space while unable to fly, water tile while a slime, lava, etc).

proc
register_dangerous_object
(/obj/O)

Tells the turf that it currently contains something that automated movement should consider if planning to enter the tile. This uses lazy list macros to reduce memory footprint since for 99% of turfs the list would've been empty anyway.

proc
setup_zmimic
(mapload)

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

proc
unregister_dangerous_object
(/obj/O)

Similar to register_dangerous_object(), for when the dangerous object stops being dangerous/gets deleted/moved/etc.

turf /turf inherits /atom

Vars

Procs

Var Details

var above – /turf

var ambient_active –

var ao_overlays – /list

var dangerous_objects – /list

var external_atmosphere_participation –

var mimic_above_copy – /atom/movable/openspace/turf_mimic

var mimic_proxy – /atom/movable/openspace/turf_proxy

var mimic_underlay – /atom/movable/openspace/turf_proxy

var shadower – /atom/movable/openspace/multiplier

var turf_fire – /obj/turf_fire

var z_eventually_space –

var z_queued –

var zone_membership_candidate –