code/__defines/zmimic.dm

ZM_VISUALLY_BIG_STOPS_VB_PROPAGATION	If this is enabled (default), a VISUALLY_BIG turf will stop upwards propagation of OVER_VB (visually big) within a stack. It is assumed that a turf that is VISUALLY_BIG will be the same size or larger as the turfs below it, so it will stop upwards propagation of the ABOVE_VB flag to avoid creating a bunch of turf proxy objects that players aren't going to see anyway. This should be enabled if your VISUALLY_BIG turfs are usually or always larger than the turfs that might be below them, but it may cause edges of turfs below that logically should be visible to not render. This artifact is unlikely to be noticed by players though, and older versions of Z-Mimic did not render even the more visible case anyway. Disabling this may increase memory usage if your map contains a large amount of VISUALLY_BIG turfs.
ZM_DEBUG_LOG	Enable extra ZM debug logs -- these are useful for diagnosing layering issues, but they're potentially expensive.
TURF_IS_MIMIC	Is this a full Z-turf?
TURF_IS_MIMICKING	Is this turf participating in Z-mimic?
MOVABLE_IS_BELOW_ZTURF	Is this movable visible from a turf that is mimicking below? Note: this does not necessarily mean directly below.
MOVABLE_IS_ON_ZTURF	Is this movable located on a turf that is mimicking below? Note: this does not necessarily mean directly on.
ZM_TURF_FORCE_TERMINATES	Is this turf always the end of a scan?
ZM_TURF_DOES_NOT_TERMINATE_ROOT_SCAN	Should the ZM turf root scan progress through this turf? This is the visually terminating turf, the one that's actually visible here (so, stops at boundaries).
ZM_TURF_DOES_NOT_TERMINATE_VB_SCAN	Should the ZM oversize turf scan progress through this turf? These are turfs that are above a turf flagged as VISUALLY_BIG.
ZM_TURF_DOES_NOT_TERMINATE_Z_STACK	Should the ZM z-stack scan progress through this turf? This is the actual root of the z-stack as far as movable render is concerned (so, this includes boundaries).
ZM_MIMIC_BELOW	If this turf should mimic the turf on the Z below.
ZM_MIMIC_REPLACE	If this turf is Z-mimicking, replace the turf's appearance instead of using a movable. This is faster, but means the turf cannot have its own appearance (say, edges or a translucent sprite).
ZM_ALLOW_LIGHTING	If this turf should permit passage of lighting.
ZM_ALLOW_ATMOS	If this turf permits passage of air.
ZM_MIMIC_NO_AO	If the turf shouldn't apply regular turf AO and only do Z-mimic AO.
ZM_NO_OCCLUDE	Don't occlude below atoms if we're a non-mimic z-turf.
ZM_OVERRIDE	Copy only z_appearance or baseturf and bail, do not attempt to copy movables. This is significantly cheaper and allows you to override the mimic, but results in movables not being visible. This also terminates the Z-stack for purposes of ZM invariants.
ZM_BOUNDARY	Internal use. Partially mimic the turf: allow creation of movables, but do not copy the actual turf. Movables are hidden from rightclick.
ZM_HIDE_ATOMS	If this turf is considered opaque to mouse clicks, also hide below mimics from the right-click menu. This makes it impossible to examine atoms below, however.
ZM_VISUALLY_BIG	This turf is visually larger than WORLD_ICON_SIZE, so we need to copy it even if it isn't directly visible.
ZM_OVER_VB	Internal use. This turf is above a turf that is VISUALLY_BIG.
ZM_MIMIC_NO_ZAO	Skip Z-AO for this turf. Useful for border turfs where the AO wouldn't be visible anyway, since this is cheaper.
ZM_MIMIC_DEFAULTS	Common defaults for zturfs.
ZMM_WIDE_LOAD	Atom is big and needs to scan one extra turf in both X and Y. This only extends the range by one turf. Cheap, but not free.
ZM_MIMIC_PRESET_HOLE	Preset: you're creating a hole in the ground. No icon, nothing to cast shadows on. Just a hole.
ZM_MIMIC_PRESET_HOLE_WITH_BORDER	Preset: you're creating a hole in the ground with a border. This turf has an icon, but you want to be able to click things in the hole like with a regular Z-hole.
ZM_MIMIC_PRESET_TRANSLUCENT_TURF	Preset: you're creating a turf with translucent accents (like glass flooring). This will block clicks even where alpha on the icon is 0, add MIMIC_NO_OCCLUDE if this is unwanted.
ZM_FLAGS_AFFECTS_VIS	Flags that affect mimic right-click visibility (maps to ZM_HIDE_*).
ZM_FLAGS_AFFECTS_LAYERING	Flags that affect mimic layering (different render slice placement).
ZM_FLAGS_CAN_TURF_UPDATE	At least one of these flags is required for a turf to go through Z-Copy update.
ZM_INFECTIOUS_MIMIC_FLAGS	Flags that persist across changeturf.
ZM_HIDE_BOUNDARY	This mimic is being hidden by its parent being a boundary.
ZM_HIDE_NONMIMIC	This mimic is being hidden by its parent not being a mimic.
ZM_HIDE_OPAQUE	This mimic is being hidden by its parent having mouse_opacity set with MIMIC_HIDE_ATOMS active.
ZMM_IGNORE	Do not copy this movable.
ZMM_MANGLE_PLANES	Check this movable's overlays/underlays for explicit plane use and mangle for compatibility with Z-Mimic. If you're using emissive overlays, you probably should be using this flag. Expensive, only use if necessary.
ZMM_LOOKAHEAD	Look one turf ahead and one turf back when considering z-turfs that might be seeing this atom. Cheap, but not free.
ZMM_LOOKBESIDE	Look one turf beside (left/right) when considering z-turfs that might be seeing this atom. Cheap, but not free.

Define Details

#define
MOVABLE_IS_BELOW_ZTURF
(M)

Is this movable visible from a turf that is mimicking below? Note: this does not necessarily mean directly below.

#define
MOVABLE_IS_ON_ZTURF
(M)

Is this movable located on a turf that is mimicking below? Note: this does not necessarily mean directly on.

#define
TURF_IS_MIMIC
(T)

Is this a full Z-turf?

#define
TURF_IS_MIMICKING
(T)

Is this turf participating in Z-mimic?

#define
ZMM_IGNORE

Do not copy this movable.

#define
ZMM_LOOKAHEAD

Look one turf ahead and one turf back when considering z-turfs that might be seeing this atom. Cheap, but not free.

#define
ZMM_LOOKBESIDE

Look one turf beside (left/right) when considering z-turfs that might be seeing this atom. Cheap, but not free.

#define
ZMM_MANGLE_PLANES

Check this movable's overlays/underlays for explicit plane use and mangle for compatibility with Z-Mimic. If you're using emissive overlays, you probably should be using this flag. Expensive, only use if necessary.

#define
ZMM_WIDE_LOAD

Atom is big and needs to scan one extra turf in both X and Y. This only extends the range by one turf. Cheap, but not free.

#define
ZM_ALLOW_ATMOS

If this turf permits passage of air.

#define
ZM_ALLOW_LIGHTING

If this turf should permit passage of lighting.

#define
ZM_BOUNDARY

Internal use. Partially mimic the turf: allow creation of movables, but do not copy the actual turf. Movables are hidden from rightclick.

#define
ZM_DEBUG_LOG
(X ...)

Enable extra ZM debug logs -- these are useful for diagnosing layering issues, but they're potentially expensive.

#define
ZM_FLAGS_AFFECTS_LAYERING

Flags that affect mimic layering (different render slice placement).

#define
ZM_FLAGS_AFFECTS_VIS

Flags that affect mimic right-click visibility (maps to ZM_HIDE_*).

#define
ZM_FLAGS_CAN_TURF_UPDATE

At least one of these flags is required for a turf to go through Z-Copy update.

#define
ZM_HIDE_ATOMS

If this turf is considered opaque to mouse clicks, also hide below mimics from the right-click menu. This makes it impossible to examine atoms below, however.

#define
ZM_HIDE_BOUNDARY

This mimic is being hidden by its parent being a boundary.

#define
ZM_HIDE_NONMIMIC

This mimic is being hidden by its parent not being a mimic.

#define
ZM_HIDE_OPAQUE

This mimic is being hidden by its parent having mouse_opacity set with MIMIC_HIDE_ATOMS active.

#define
ZM_INFECTIOUS_MIMIC_FLAGS

Flags that persist across changeturf.

#define
ZM_MIMIC_BELOW

If this turf should mimic the turf on the Z below.

#define
ZM_MIMIC_DEFAULTS

Common defaults for zturfs.

#define
ZM_MIMIC_NO_AO

If the turf shouldn't apply regular turf AO and only do Z-mimic AO.

#define
ZM_MIMIC_NO_ZAO

Skip Z-AO for this turf. Useful for border turfs where the AO wouldn't be visible anyway, since this is cheaper.

#define
ZM_MIMIC_PRESET_HOLE

Preset: you're creating a hole in the ground. No icon, nothing to cast shadows on. Just a hole.

#define
ZM_MIMIC_PRESET_HOLE_WITH_BORDER

Preset: you're creating a hole in the ground with a border. This turf has an icon, but you want to be able to click things in the hole like with a regular Z-hole.

#define
ZM_MIMIC_PRESET_TRANSLUCENT_TURF

Preset: you're creating a turf with translucent accents (like glass flooring). This will block clicks even where alpha on the icon is 0, add MIMIC_NO_OCCLUDE if this is unwanted.

#define
ZM_MIMIC_REPLACE

If this turf is Z-mimicking, replace the turf's appearance instead of using a movable. This is faster, but means the turf cannot have its own appearance (say, edges or a translucent sprite).

#define
ZM_NO_OCCLUDE

Don't occlude below atoms if we're a non-mimic z-turf.

#define
ZM_OVERRIDE

Copy only z_appearance or baseturf and bail, do not attempt to copy movables. This is significantly cheaper and allows you to override the mimic, but results in movables not being visible. This also terminates the Z-stack for purposes of ZM invariants.

#define
ZM_OVER_VB

Internal use. This turf is above a turf that is VISUALLY_BIG.

#define
ZM_TURF_DOES_NOT_TERMINATE_ROOT_SCAN
(T)

Should the ZM turf root scan progress through this turf? This is the visually terminating turf, the one that's actually visible here (so, stops at boundaries).

#define
ZM_TURF_DOES_NOT_TERMINATE_VB_SCAN
(T)

Should the ZM oversize turf scan progress through this turf? These are turfs that are above a turf flagged as VISUALLY_BIG.

#define
ZM_TURF_DOES_NOT_TERMINATE_Z_STACK
(T)

Should the ZM z-stack scan progress through this turf? This is the actual root of the z-stack as far as movable render is concerned (so, this includes boundaries).

#define
ZM_TURF_FORCE_TERMINATES
(T)

Is this turf always the end of a scan?

#define
ZM_VISUALLY_BIG

This turf is visually larger than WORLD_ICON_SIZE, so we need to copy it even if it isn't directly visible.

#define
ZM_VISUALLY_BIG_STOPS_VB_PROPAGATION

If this is enabled (default), a VISUALLY_BIG turf will stop upwards propagation of OVER_VB (visually big) within a stack. It is assumed that a turf that is VISUALLY_BIG will be the same size or larger as the turfs below it, so it will stop upwards propagation of the ABOVE_VB flag to avoid creating a bunch of turf proxy objects that players aren't going to see anyway. This should be enabled if your VISUALLY_BIG turfs are usually or always larger than the turfs that might be below them, but it may cause edges of turfs below that logically should be visible to not render. This artifact is unlikely to be noticed by players though, and older versions of Z-Mimic did not render even the more visible case anyway. Disabling this may increase memory usage if your map contains a large amount of VISUALLY_BIG turfs.

code/__defines/zmimic.dm

Define Details

#define MOVABLE_IS_BELOW_ZTURF(M)

#define MOVABLE_IS_ON_ZTURF(M)

#define TURF_IS_MIMIC(T)

#define TURF_IS_MIMICKING(T)

#define ZMM_IGNORE

#define ZMM_LOOKAHEAD

#define ZMM_LOOKBESIDE

#define ZMM_MANGLE_PLANES

#define ZMM_WIDE_LOAD

#define ZM_ALLOW_ATMOS

#define ZM_ALLOW_LIGHTING

#define ZM_BOUNDARY

#define ZM_DEBUG_LOG(X ...)

#define ZM_FLAGS_AFFECTS_LAYERING

#define ZM_FLAGS_AFFECTS_VIS

#define ZM_FLAGS_CAN_TURF_UPDATE

#define ZM_HIDE_ATOMS

#define ZM_HIDE_BOUNDARY

#define ZM_HIDE_NONMIMIC

#define ZM_HIDE_OPAQUE

#define ZM_INFECTIOUS_MIMIC_FLAGS

#define ZM_MIMIC_BELOW

#define ZM_MIMIC_DEFAULTS

#define ZM_MIMIC_NO_AO

#define ZM_MIMIC_NO_ZAO

#define ZM_MIMIC_PRESET_HOLE

#define ZM_MIMIC_PRESET_HOLE_WITH_BORDER

#define ZM_MIMIC_PRESET_TRANSLUCENT_TURF

#define ZM_MIMIC_REPLACE

#define ZM_NO_OCCLUDE

#define ZM_OVERRIDE

#define ZM_OVER_VB

#define ZM_TURF_DOES_NOT_TERMINATE_ROOT_SCAN(T)

#define ZM_TURF_DOES_NOT_TERMINATE_VB_SCAN(T)

#define ZM_TURF_DOES_NOT_TERMINATE_Z_STACK(T)

#define ZM_TURF_FORCE_TERMINATES(T)

#define ZM_VISUALLY_BIG

#define ZM_VISUALLY_BIG_STOPS_VB_PROPAGATION