code/__HELPERS/_planes.dm

SET_PLANE	Takes an atom to change the plane of, a new plane value, and something that can be used as a reference to a z level as input Modifies the new value to match the plane we actually want. Note, if you pass in an already offset plane the offsets will add up Use PLANE_TO_TRUE() to avoid this
MUTATE_PLANE	Takes a plane and a z reference, and offsets the plane by the mutation The SSmapping.max_plane_offset bit here is technically redundant, but saves a bit of work in the base case And the base case is important to me. Non multiz shouldn't get hit too bad by this code
GET_TURF_PLANE_OFFSET	Takes a z reference that we are unsure of, sanity checks it Returns either its offset, or 0 if it's not a valid ref Will return the reference's PLANE'S offset if we can't get anything out of the z level. We do our best
GET_Z_PLANE_OFFSET	Essentially just an unsafe version of GET_TURF_PLANE_OFFSET() Takes a z value we returns its offset with a list lookup Will runtime during parts of init. Be careful :)
GET_NEW_PLANE	Takes a plane to offset, and the multiplier to use, and well, does the offsetting Respects a blacklist we use to remove redundant plane masters, such as hud objects
SET_PLANE_W_SCALAR	Takes an object, new plane, and multipler, and offsets the plane This is for cases where you have a multipler precalculated, and just want to use it Often an optimization, sometimes a necessity
SET_PLANE_IMPLICIT	Implicit plane set. We take the turf from the object we're changing the plane of, and use ITS z as a spokesperson for our plane value
GET_LOWEST_STACK_OFFSET	Takes a z level, gets the lowest plane offset in its "stack"
PLANE_TO_TRUE	Takes a plane, returns the canonical, unoffset plane it represents
PLANE_TO_OFFSET	Takes a plane, returns the offset it uses
PLANE_IS_CRITICAL	Takes a plane, returns TRUE if it is of critical priority, FALSE otherwise
TRUE_PLANE_TO_OFFSETS	Takes a true plane, returns the offset planes that would canonically represent it
OFFSET_RENDER_TARGET	Takes a render target and an offset, returns a canonical render target string for it
_OFFSET_RENDER_TARGET	Helper macro for the above Honestly just exists to make the pattern of render target strings more readable

Define Details

#define
GET_LOWEST_STACK_OFFSET
(z)

Takes a z level, gets the lowest plane offset in its "stack"

#define
GET_NEW_PLANE
(new_value, multiplier)

Takes a plane to offset, and the multiplier to use, and well, does the offsetting Respects a blacklist we use to remove redundant plane masters, such as hud objects

#define
GET_TURF_PLANE_OFFSET
(z_reference)

Takes a z reference that we are unsure of, sanity checks it Returns either its offset, or 0 if it's not a valid ref Will return the reference's PLANE'S offset if we can't get anything out of the z level. We do our best

#define
GET_Z_PLANE_OFFSET
(z)

Essentially just an unsafe version of GET_TURF_PLANE_OFFSET() Takes a z value we returns its offset with a list lookup Will runtime during parts of init. Be careful :)

#define
MUTATE_PLANE
(new_value, z_reference)

Takes a plane and a z reference, and offsets the plane by the mutation The SSmapping.max_plane_offset bit here is technically redundant, but saves a bit of work in the base case And the base case is important to me. Non multiz shouldn't get hit too bad by this code

#define
OFFSET_RENDER_TARGET
(render_target, offset)

Takes a render target and an offset, returns a canonical render target string for it

#define
PLANE_IS_CRITICAL
(plane)

Takes a plane, returns TRUE if it is of critical priority, FALSE otherwise

#define
PLANE_TO_OFFSET
(plane)

Takes a plane, returns the offset it uses

#define
PLANE_TO_TRUE
(plane)

Takes a plane, returns the canonical, unoffset plane it represents

#define
SET_PLANE
(thing, new_value, z_reference)

Takes an atom to change the plane of, a new plane value, and something that can be used as a reference to a z level as input Modifies the new value to match the plane we actually want. Note, if you pass in an already offset plane the offsets will add up Use PLANE_TO_TRUE() to avoid this

#define
SET_PLANE_IMPLICIT
(thing, new_value)

Implicit plane set. We take the turf from the object we're changing the plane of, and use ITS z as a spokesperson for our plane value

#define
SET_PLANE_W_SCALAR
(thing, new_value, multiplier)

Takes an object, new plane, and multipler, and offsets the plane This is for cases where you have a multipler precalculated, and just want to use it Often an optimization, sometimes a necessity

#define
TRUE_PLANE_TO_OFFSETS
(plane)

Takes a true plane, returns the offset planes that would canonically represent it

#define
_OFFSET_RENDER_TARGET
(render_target, offset)

Helper macro for the above Honestly just exists to make the pattern of render target strings more readable

code/__HELPERS/_planes.dm

Define Details

#define GET_LOWEST_STACK_OFFSET (z)

#define GET_NEW_PLANE (new_value, multiplier)

#define GET_TURF_PLANE_OFFSET (z_reference)

#define GET_Z_PLANE_OFFSET (z)

#define MUTATE_PLANE (new_value, z_reference)

#define OFFSET_RENDER_TARGET (render_target, offset)

#define PLANE_IS_CRITICAL (plane)

#define PLANE_TO_OFFSET (plane)

#define PLANE_TO_TRUE (plane)

#define SET_PLANE (thing, new_value, z_reference)

#define SET_PLANE_IMPLICIT (thing, new_value)

#define SET_PLANE_W_SCALAR (thing, new_value, multiplier)

#define TRUE_PLANE_TO_OFFSETS (plane)

#define _OFFSET_RENDER_TARGET (render_target, offset)