mapping

Vars
adding_new_zlevel	True when in the process of adding a new Z-level, global locking
biomes	All possible biomes in assoc list as type \|\| instance
critical_planes	List of plane masters that are of critical priority
current_map	The current map config the server loaded at round start.
gravity_by_z_level	shows the default gravity value for each z level. recalculated when gravity generators change. List in the form: list(z level num = max generator gravity in that z level OR the gravity level trait)
lists_to_reserve	List of lists of turfs to reserve
loaded_lazy_templates	list of lazy templates that have been loaded
max_plane_offset	The largest plane offset we've generated so far
multiz_levels	list of all z level indices that form multiz connections and whether theyre linked up or down. list of lists, inner lists are of the form: list("up or down link direction" = TRUE)
plane_offset_blacklist	List of planes that do not allow for offsetting
plane_offset_to_true	Assoc list of string plane values to their true, non offset representation
plane_to_offset	Assoc list of string plane to the plane's offset value
render_offset_blacklist	List of render targets that do not allow for offsetting
themed_ruins	List of ruins, separated by their theme
true_to_offset_planes	Assoc list of true string plane values to a list of all potential offset planess
z_level_to_lowest_plane_offset	List of z level (as number) -> The lowest plane offset in that z stack
z_level_to_plane_offset	List of z level (as number) -> plane offset of that z level Used to maintain the plane cube
z_level_to_stack	List of z level (as number) -> list of all z levels vertically connected to ours Useful for fast grouping lookups and such
z_list	list of all z level datums in the order of their z (z level 1 is at index 1, etc.)
z_trait_levels	list of traits and their associated z leves
Procs
add_new_zlevel	Generates a real, honest to god new z level. Will create the actual space, and also generate a datum that holds info about the new plot of land Accepts the name, traits list, datum type, and if we should manage the turfs we create
add_reservation_zlevel	Adds a new reservation z level. A bit of space that can be handed out on request Of note, reservations default to transit turfs, to make their most common use, shuttles, faster
generate_offset_lists	Takes an offset to generate misc lists to, and a base to start from Use this to react globally to maintain parity with plane offsets
generate_station_area_list	Generates the global station area list, filling it with typepaths of unique areas found on the station Z.
get_connected_levels	Takes a turf or a z level, and returns a list of all the z levels that are connected to it
get_level	Returns the /datum/space_level associated with the given z level.
get_station_center	Prefer not to use this one too often
initialize_biomes	Initialize all biomes, assoc as type \|\| instance
initialize_reserved_level	Sets up a z level as reserved This is not for wiping reserved levels, use wipe_reservations() for that. If this is called after SSatom init, it will call Initialize on all turfs on the passed z, as its name promises
is_planetary	Returns true if the map we're playing on is on a planet
level_has_all_traits	Check if levels[z] has all of the specified traits
level_has_any_trait	Check if levels[z] has any of the specified traits
level_trait	Look up levels[z].traits[trait]
levels_by_all_traits	Get a list of all z which have all of the specified traits
levels_by_any_trait	Get a list of all z which have any of the specified traits
levels_by_trait	Get a list of all z which have the specified trait
load_all_away_missions	For debug purposes, will add every single away mission present in a given directory. You can optionally pass in a string directory to load from instead of the default.
manage_z_level	Takes a z level datum, and tells the mapping subsystem to manage it Also handles things like plane offset generation, and other things that happen on a z level to z level basis
request_turf_block_reservation	Requests a /datum/turf_reservation based on the given width, height, and z_size. You can specify a z_reservation to use a specific z level, or leave it null to use any z level.
reserve_turfs	Schedules a group of turfs to be handed back to the reservation system's control If await is true, will sleep until the turfs are finished work
run_map_terrain_generation	Generate the turfs of the area
run_map_terrain_population	Populate the turfs of the area
setup_rivers	Sets up rivers, and things that behave like rivers. So lava/plasma rivers, and chasms It is important that this happens AFTER generating mineral walls and such, since we rely on them for river logic
setup_ruins	##setup_ruins
validate_z_level_loading	Lightweight proc that just checks to make sure that all of the expected z-levels were loaded. Split out for clarity from load_all_away_missions() Argument "checkable_levels" is just a list of the names (typically the filepaths) of the z-levels we were expected to load, which should correspond to the name on the space level datum.

Var Details

var
adding_new_zlevel

True when in the process of adding a new Z-level, global locking

var
biomes
– /list

All possible biomes in assoc list as type || instance

var
critical_planes
– /list

List of plane masters that are of critical priority

var
current_map
– /datum/map_config

The current map config the server loaded at round start.

var
gravity_by_z_level
– /list

shows the default gravity value for each z level. recalculated when gravity generators change. List in the form: list(z level num = max generator gravity in that z level OR the gravity level trait)

var
lists_to_reserve
– /list

List of lists of turfs to reserve

var
loaded_lazy_templates
– /list

list of lazy templates that have been loaded

var
max_plane_offset

The largest plane offset we've generated so far

var
multiz_levels
– /list

list of all z level indices that form multiz connections and whether theyre linked up or down. list of lists, inner lists are of the form: list("up or down link direction" = TRUE)

var
plane_offset_blacklist
– /list

List of planes that do not allow for offsetting

var
plane_offset_to_true
– /list

Assoc list of string plane values to their true, non offset representation

var
plane_to_offset
– /list

Assoc list of string plane to the plane's offset value

var
render_offset_blacklist
– /list

List of render targets that do not allow for offsetting

var
themed_ruins
– /list

List of ruins, separated by their theme

var
true_to_offset_planes
– /list

Assoc list of true string plane values to a list of all potential offset planess

var
z_level_to_lowest_plane_offset
– /list

List of z level (as number) -> The lowest plane offset in that z stack

var
z_level_to_plane_offset
– /list

List of z level (as number) -> plane offset of that z level Used to maintain the plane cube

var
z_level_to_stack
– /list

List of z level (as number) -> list of all z levels vertically connected to ours Useful for fast grouping lookups and such

var
z_list
– /list/datum/space_level

list of all z level datums in the order of their z (z level 1 is at index 1, etc.)

var
z_trait_levels
– /list

list of traits and their associated z leves

Proc Details

proc
add_new_zlevel
(name, traits, z_type, contain_turfs)

Generates a real, honest to god new z level. Will create the actual space, and also generate a datum that holds info about the new plot of land Accepts the name, traits list, datum type, and if we should manage the turfs we create

proc
add_reservation_zlevel
(for_shuttles)

Adds a new reservation z level. A bit of space that can be handed out on request Of note, reservations default to transit turfs, to make their most common use, shuttles, faster

proc
generate_offset_lists
(gen_from, new_offset)

Takes an offset to generate misc lists to, and a base to start from Use this to react globally to maintain parity with plane offsets

proc
generate_station_area_list
()

Generates the global station area list, filling it with typepaths of unique areas found on the station Z.

proc
get_connected_levels
(/turf/connected)

Takes a turf or a z level, and returns a list of all the z levels that are connected to it

proc
get_level
(z) as /datum/space_level

Returns the /datum/space_level associated with the given z level.

proc
get_station_center
()

Prefer not to use this one too often

proc
initialize_biomes
()

Initialize all biomes, assoc as type || instance

proc
initialize_reserved_level
(z)

Sets up a z level as reserved This is not for wiping reserved levels, use wipe_reservations() for that. If this is called after SSatom init, it will call Initialize on all turfs on the passed z, as its name promises

proc
is_planetary
()

Returns true if the map we're playing on is on a planet

proc
level_has_all_traits
(z, /list/traits)

Check if levels[z] has all of the specified traits

proc
level_has_any_trait
(z, /list/traits)

Check if levels[z] has any of the specified traits

proc
level_trait
(z, trait)

Look up levels[z].traits[trait]

proc
levels_by_all_traits
(/list/traits)

Get a list of all z which have all of the specified traits

proc
levels_by_any_trait
(/list/traits)

Get a list of all z which have any of the specified traits

proc
levels_by_trait
(trait)

Get a list of all z which have the specified trait

proc
load_all_away_missions
(map_directory)

For debug purposes, will add every single away mission present in a given directory. You can optionally pass in a string directory to load from instead of the default.

proc
manage_z_level
(/datum/space_level/new_z, filled_with_space, contain_turfs)

Takes a z level datum, and tells the mapping subsystem to manage it Also handles things like plane offset generation, and other things that happen on a z level to z level basis

proc
request_turf_block_reservation
(width, height, z_size, z_reservation, reservation_type, turf_type_override)

Requests a /datum/turf_reservation based on the given width, height, and z_size. You can specify a z_reservation to use a specific z level, or leave it null to use any z level.

proc
reserve_turfs
(/list/turfs, await)

Schedules a group of turfs to be handed back to the reservation system's control If await is true, will sleep until the turfs are finished work

proc
run_map_terrain_generation
()

Generate the turfs of the area

proc
run_map_terrain_population
()

Populate the turfs of the area

proc
setup_rivers
()

Sets up rivers, and things that behave like rivers. So lava/plasma rivers, and chasms It is important that this happens AFTER generating mineral walls and such, since we rely on them for river logic

proc
setup_ruins
()

##setup_ruins

Sets up all of the ruins to be spawned

proc
validate_z_level_loading
(/list/checkable_levels)

Lightweight proc that just checks to make sure that all of the expected z-levels were loaded. Split out for clarity from load_all_away_missions() Argument "checkable_levels" is just a list of the names (typically the filepaths) of the z-levels we were expected to load, which should correspond to the name on the space level datum.

mapping /datum/controller/subsystem/mapping

Vars

Procs

Var Details

var adding_new_zlevel

var biomes – /list

var critical_planes – /list

var current_map – /datum/map_config

var gravity_by_z_level – /list

var lists_to_reserve – /list

var loaded_lazy_templates – /list

var max_plane_offset

var multiz_levels – /list

var plane_offset_blacklist – /list

var plane_offset_to_true – /list

var plane_to_offset – /list

var render_offset_blacklist – /list

var themed_ruins – /list

var true_to_offset_planes – /list

var z_level_to_lowest_plane_offset – /list

var z_level_to_plane_offset – /list

var z_level_to_stack – /list

var z_list – /list/datum/space_level

var z_trait_levels – /list

Proc Details

proc add_new_zlevel(name, traits, z_type, contain_turfs)

proc add_reservation_zlevel(for_shuttles)

proc generate_offset_lists(gen_from, new_offset)

proc generate_station_area_list()

proc get_connected_levels(/turf/connected)

proc get_level(z) as /datum/space_level

proc get_station_center()

proc initialize_biomes()

proc initialize_reserved_level(z)

proc is_planetary()

proc level_has_all_traits(z, /list/traits)

proc level_has_any_trait(z, /list/traits)

proc level_trait(z, trait)

proc levels_by_all_traits(/list/traits)

proc levels_by_any_trait(/list/traits)

proc levels_by_trait(trait)

proc load_all_away_missions(map_directory)

proc manage_z_level(/datum/space_level/new_z, filled_with_space, contain_turfs)

proc request_turf_block_reservation(width, height, z_size, z_reservation, reservation_type, turf_type_override)

proc reserve_turfs(/list/turfs, await)

proc run_map_terrain_generation()

proc run_map_terrain_population()

proc setup_rivers()

proc setup_ruins()

proc validate_z_level_loading(/list/checkable_levels)