mapping

Vars
adding_new_zlevel	True when in the process of adding a new Z-level, global locking
critical_planes	List of plane masters that are of critical priority
gravity_by_z_level	shows the gravity value for each z level
groundmap_voted	If true, non-admin players will not be able to initiate a vote to change groundmap
last_round_player_count	The number of connected clients for the previous round
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
modular_templates	list of all modular mapping templates
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
shipmap_voted	If true, non-admin players will not be able to initiate a vote to change shipmap
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_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
calculate_default_z_level_gravities	Generates baseline gravity levels for all z-levels based off traits
calculate_z_level_gravity	Calculates the gravity for a z-level
generate_linkages_for_z_level	generates z level linkages for multiz for a given z
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_z_level_linkages	generates z level linkages for all 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_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
lazy_load_template	lazy loads a map template in a reserved z. use for stuff like rooms that you teleport to like interiors or similar
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_last_round_playercount	Loads the number of players we had last round, for use in modular mapping
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
wipe_reservations	clears all map reservations

Var Details

var
adding_new_zlevel
–

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

var
critical_planes
– /list

List of plane masters that are of critical priority

var
gravity_by_z_level
– /list

shows the gravity value for each z level

var
groundmap_voted
–

If true, non-admin players will not be able to initiate a vote to change groundmap

var
last_round_player_count
–

The number of connected clients for the previous round

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

list of all modular mapping templates

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

If true, non-admin players will not be able to initiate a vote to change shipmap

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

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_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
calculate_default_z_level_gravities
()

Generates baseline gravity levels for all z-levels based off traits

proc
calculate_z_level_gravity
(z_level_number)

Calculates the gravity for a z-level

proc
generate_linkages_for_z_level
(z_level)

generates z level linkages for multiz for a given z

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_z_level_linkages
()

generates z level linkages for all 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)

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_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
lazy_load_template
(template_key, force)

lazy loads a map template in a reserved z. use for stuff like rooms that you teleport to like interiors or similar

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_last_round_playercount
()

Loads the number of players we had last round, for use in modular mapping

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
wipe_reservations
(wipe_safety_delay)

clears all map reservations

mapping /datum/controller/subsystem/mapping

Vars

Procs

Var Details

var adding_new_zlevel –

var critical_planes – /list

var gravity_by_z_level – /list

var groundmap_voted –

var last_round_player_count –

var lists_to_reserve – /list

var loaded_lazy_templates – /list

var max_plane_offset –

var modular_templates – /list

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

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

var z_trait_levels – /list

Proc Details

proc add_reservation_zlevel(for_shuttles)

proc calculate_default_z_level_gravities()

proc calculate_z_level_gravity(z_level_number)

proc generate_linkages_for_z_level(z_level)

proc generate_offset_lists(gen_from, new_offset)

proc generate_z_level_linkages()

proc get_connected_levels(/turf/connected)

proc get_level(z)

proc get_station_center()

proc initialize_reserved_level(z)

proc lazy_load_template(template_key, force)

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_last_round_playercount()

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 wipe_reservations(wipe_safety_delay)