mapping

Vars
critical_planes	List of plane masters that are of critical priority
existing_station_areas	List of areas that exist on the station this shift
fallback_map	Waht map to fallback
ghostteleportlocs	List of all areas that can be accessed via IC and OOC means
lavaland_theme	What do we have as the lavaland theme today?
lists_to_reserve	List of lists of turfs to reserve
map_datum	What map datum are we using
max_plane_offset	The largest plane offset we've generated so far
multiz_levels	list of lists, inner lists are of the form: list("up or down link direction" = TRUE)
next_map	What map will be used next round
num_of_res_levels	Amount of reserved levels we created so far. Mostly we will have only one
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
previous_maps	Maps played in previous rounds, stores typepaths
render_offset_blacklist	List of render targets that do not allow for offsetting
teleportlocs	List of all areas that can be accessed via IC means
true_to_offset_planes	Assoc list of true string plane values to a list of all potential offset planess
turf_reservations	list of turf reservations
unused_turfs	Not actually unused turfs they're unused but reserved for use for whatever requests them. "[zlevel_of_turf]" = list(turfs)
used_turfs	list of turf = datum/turf_reservation
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
Procs
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
get_connected_levels	Takes a turf or a z level, and returns a list of all the z levels that are connected to it
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

Var Details

var
critical_planes
– /list

List of plane masters that are of critical priority

var
existing_station_areas
– /list

List of areas that exist on the station this shift

var
fallback_map
– /datum/map

Waht map to fallback

var
ghostteleportlocs
– /list

List of all areas that can be accessed via IC and OOC means

var
lavaland_theme
– /datum/lavaland_theme

What do we have as the lavaland theme today?

var
lists_to_reserve
– /list

List of lists of turfs to reserve

var
map_datum
– /datum/map

What map datum are we using

var
max_plane_offset
–

The largest plane offset we've generated so far

var
multiz_levels
– /list

list of lists, inner lists are of the form: list("up or down link direction" = TRUE)

var
next_map
– /datum/map

What map will be used next round

var
num_of_res_levels
–

Amount of reserved levels we created so far. Mostly we will have only one

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
previous_maps
– /list

Maps played in previous rounds, stores typepaths

var
render_offset_blacklist
– /list

List of render targets that do not allow for offsetting

var
teleportlocs
– /list

List of all areas that can be accessed via IC means

var
true_to_offset_planes
– /list

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

var
turf_reservations
– /list/datum

list of turf reservations

var
unused_turfs
– /list/turf

Not actually unused turfs they're unused but reserved for use for whatever requests them. "[zlevel_of_turf]" = list(turfs)

var
used_turfs
– /list

list of turf = datum/turf_reservation

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

Proc Details

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
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
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

mapping /datum/controller/subsystem/mapping

Vars

Procs

Var Details

var critical_planes – /list

var existing_station_areas – /list

var fallback_map – /datum/map

var ghostteleportlocs – /list

var lavaland_theme – /datum/lavaland_theme

var lists_to_reserve – /list

var map_datum – /datum/map

var max_plane_offset –

var multiz_levels – /list

var next_map – /datum/map

var num_of_res_levels –

var plane_offset_blacklist – /list

var plane_offset_to_true – /list

var plane_to_offset – /list

var previous_maps – /list

var render_offset_blacklist – /list

var teleportlocs – /list

var true_to_offset_planes – /list

var turf_reservations – /list/datum

var unused_turfs – /list/turf

var used_turfs – /list

var z_level_to_lowest_plane_offset – /list

var z_level_to_plane_offset – /list

var z_level_to_stack – /list