Space Station 13 - Modules - TypesVar Details - Proc Details

turf

Vars

aboveReference to any open turf that might be above us to speed up atom Entered() updates.
ambient_activeDo we have non-zero ambient light? Use [TURF_IS_AMBIENT_LIT] instead of reading this directly.
ao_overlaysCurrent ambient occlusion overlays. Tracked so we can reverse them without dropping all priority overlays.
dangerous_objectsList of 'dangerous' objs that the turf holds that can cause something bad to happen when stepped on, used for AI mobs.
mimic_above_copyIf this is a delegate (non-overwrite) Z-turf with a z-turf above, this is the delegate copy that's copying us.
mimic_proxyIf we're a non-overwrite z-turf, this holds the appearance of the bottom-most Z-turf in the z-stack.
mimic_underlayIf we're at the bottom of the stack, a proxy used to fake a below space turf.
shadowerOverlay used to multiply color of all OO overlays at once.
turf_fireReference to the turf fire on the turf
z_eventually_spaceIf this Z-turf leads to space, uninterrupted.
z_queuedHow many times this turf is currently queued - multiple queue occurrences are allowed to ensure update consistency.

Procs

AdjacentQuickQuick adjacency (to turf): If you are in the same turf, always true If you are not adjacent, then false
Adjacent_free_dirSimilar to Adjacent, but checks if the path FROM src in an orthogonal direction THROUGH intermediate TO destination is free without considering src turf
ClickCrossThis 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_zmimicCleans up Z-mimic objects for this turf. You shouldn't call this directly 99% of the time.
disable_zmimicDisables Z-mimic for a turf.
enable_zmimicEnables Z-mimic for a turf that didn't already have it enabled.
is_safe_to_enterReturns 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_objectTells 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_zmimicSets up Z-mimic for this turf. You shouldn't call this directly 99% of the time.
unregister_dangerous_objectSimilar to register_dangerous_object(), for when the dangerous object stops being dangerous/gets deleted/moved/etc.

Var Details

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.

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.

Proc Details

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.