mapping

Vars
accessible_z_levels	This list contains the z-level numbers which can be accessed via space travel and the percentile chances to get there.
admin_levels	List of z-levels for admin functionality (Centcom, shuttle transit, etc)
base_floor_area	Replacement area, if a base_floor_type is generated. Leave blank to skip.
base_floor_type	The turf type used when generating floors between Z-levels at startup.
base_turf_by_z	Custom base turf by Z-level. Defaults to world.turf for unlisted Z-levels
connected_z_cache	A list of connected z-levels to avoid repeatedly rebuilding connections
contact_levels	List of z-levels that can be contacted from the station, for eg announcements
levels_by_id	Associative list of levels by string ID
levels_by_z	Associative list of levels by strict z-level
map_levels	Z-levels available to various consoles, such as the crew monitor. Defaults to station_levels if unset.
planetoid_data_by_id	Associative list of planetoid/exoplanet data currently registered. The key is the planetoid id, the value is the planetoid_data datum.
planetoid_data_by_z	List of all z-levels in the world where the index corresponds to a z-level, and the key at that index is the planetoid_data datum for the associated planet
player_levels	List of z-levels a character can typically reach
queued_markers	A list of queued markers to initialize during SSmapping init.
sealed_levels	List of z-levels that don't allow random transit at edge
station_levels	List of z-levels containing the 'main map'
turbolifts_to_initialize	A list of turbolift holders to initialize.
Procs
get_connected_levels_data	Returns a list of all the level data of all the connected z levels to the given z.DBColumn
register_level_data	Registers all the needed infos from a level_data into the mapping subsystem
register_planetoid	Adds a planetoid/exoplanet's data to the lookup tables. Optionally if the topmost_level_id var is set on P, will automatically assign all linked levels to P.
register_planetoid_levels	Set the specified planetoid data for the specified level, and its connected levels.
start_processing_all_planets	Called by the roundstart hook once we toggle to in-game state
unregister_planetoid	Removes a planetoid/exoplanet's data from the lookup tables.

Var Details

var
accessible_z_levels
– /list

This list contains the z-level numbers which can be accessed via space travel and the percentile chances to get there.

var
admin_levels
– /list

List of z-levels for admin functionality (Centcom, shuttle transit, etc)

var
base_floor_area
–

Replacement area, if a base_floor_type is generated. Leave blank to skip.

var
base_floor_type
–

The turf type used when generating floors between Z-levels at startup.

var
base_turf_by_z
– /list

Custom base turf by Z-level. Defaults to world.turf for unlisted Z-levels

var
connected_z_cache
– /list

A list of connected z-levels to avoid repeatedly rebuilding connections

var
contact_levels
– /list

List of z-levels that can be contacted from the station, for eg announcements

var
levels_by_id
– /list/datum/level_data

Associative list of levels by string ID

var
levels_by_z
– /list/datum/level_data

Associative list of levels by strict z-level

var
map_levels
– /list

Z-levels available to various consoles, such as the crew monitor. Defaults to station_levels if unset.

var
planetoid_data_by_id
– /list

Associative list of planetoid/exoplanet data currently registered. The key is the planetoid id, the value is the planetoid_data datum.

var
planetoid_data_by_z
– /list

List of all z-levels in the world where the index corresponds to a z-level, and the key at that index is the planetoid_data datum for the associated planet

var
player_levels
– /list

List of z-levels a character can typically reach

var
queued_markers
– /list/obj/abstract/landmark/map_load_mark

A list of queued markers to initialize during SSmapping init.

var
sealed_levels
– /list

List of z-levels that don't allow random transit at edge

var
station_levels
– /list

List of z-levels containing the 'main map'

var
turbolifts_to_initialize
– /list

A list of turbolift holders to initialize.

Proc Details

proc
get_connected_levels_data
(z)

Returns a list of all the level data of all the connected z levels to the given z.DBColumn

proc
register_level_data
(/datum/level_data/LD)

Registers all the needed infos from a level_data into the mapping subsystem

proc
register_planetoid
(/datum/planetoid_data/P)

Adds a planetoid/exoplanet's data to the lookup tables. Optionally if the topmost_level_id var is set on P, will automatically assign all linked levels to P.

proc
register_planetoid_levels
(_z, /datum/planetoid_data/P)

Set the specified planetoid data for the specified level, and its connected levels.

proc
start_processing_all_planets
()

Called by the roundstart hook once we toggle to in-game state

proc
unregister_planetoid
(/datum/planetoid_data/P)

Removes a planetoid/exoplanet's data from the lookup tables.

mapping /datum/controller/subsystem/mapping

Vars

Procs

Var Details

var accessible_z_levels – /list

var admin_levels – /list

var base_floor_area –

var base_floor_type –

var base_turf_by_z – /list

var connected_z_cache – /list

var contact_levels – /list

var levels_by_id – /list/datum/level_data

var levels_by_z – /list/datum/level_data

var map_levels – /list

var planetoid_data_by_id – /list

var planetoid_data_by_z – /list

var player_levels – /list

var queued_markers – /list/obj/abstract/landmark/map_load_mark

var sealed_levels – /list

var station_levels – /list

var turbolifts_to_initialize – /list

Proc Details

proc get_connected_levels_data(z)

proc register_level_data(/datum/level_data/LD)

proc register_planetoid(/datum/planetoid_data/P)

proc register_planetoid_levels(_z, /datum/planetoid_data/P)

proc start_processing_all_planets()

proc unregister_planetoid(/datum/planetoid_data/P)

mapping
/datum/controller/subsystem/mapping

var
accessible_z_levels
– /list

var
admin_levels
– /list

var
base_floor_area
–

var
base_floor_type
–

var
base_turf_by_z
– /list

var
connected_z_cache
– /list

var
contact_levels
– /list

var
levels_by_id
– /list/datum/level_data

var
levels_by_z
– /list/datum/level_data

var
map_levels
– /list

var
planetoid_data_by_id
– /list

var
planetoid_data_by_z
– /list

var
player_levels
– /list

var
queued_markers
– /list/obj/abstract/landmark/map_load_mark

var
sealed_levels
– /list

var
station_levels
– /list

var
turbolifts_to_initialize
– /list

proc
get_connected_levels_data
(z)

proc
register_level_data
(/datum/level_data/LD)

proc
register_planetoid
(/datum/planetoid_data/P)

proc
register_planetoid_levels
(_z, /datum/planetoid_data/P)

proc
start_processing_all_planets
()

proc
unregister_planetoid
(/datum/planetoid_data/P)