map
/datum/map

Vars
_available_backpacks	Decl list of backpacks available to outfits and in character generation.
branch_types	list of branch datum paths for military branches available on this map
branches	All branches that exist on this map
default_job_title	Default job title which will be set in some cases.
default_job_type	Default job type which will be used if map lack of any jobs or for respawn.
default_liquid_fuel_type	A reagent used to prefill lanterns.
disconnected_disposals_tags	A list of disposals tags (sort_type var) that aren't expected to have outputs.
disconnected_wires_test_exempt_turfs	A list of lists, of the format ((x, y, z, dir),).
loadout_categories	A list of /decl/loadout_category types which will be available for characters made on this map. Uses all categories if null.
map_admin_faxes	Associative list of network URIs to a list with their display name, color, and "req_access formated" needed access list. EX: list("BIG_BOSS.COM" = list("name" = "Big boss", "color" = "#00ff00", "access" = list(list(access_heads, access_clown))))
planet_depth	The amount of z-levels generated for exoplanets. Default is 1. Be careful with this, since exoplanets are already pretty expensive.
shuttle_atmos_expectation	Defines the expected result of the atmospherics shuttle unit test for atmosphere.
spawn_branches_	Branches that a player can choose for spawning on this map, not including species restrictions.
spawn_branches_by_species_	Branches that a player can choose for spawning on this map, with species restrictions. Populated on an as-needed basis
survival_box_choices	A list of survival box types selectable for this map. If null, defaults to all defined decls. At runtime, this is an associative list of decl type -> decl.
Procs
generate_planet_spawn_lists	Fill up the list of planet_spawn_weight and guaranteed_planets
get_all_planet_templates	Returns an associative list of all the planet templates we get to pick from. The key is the template name, and the value is the template instance.
get_branch	Retrieve branch object by branch name
get_branch_by_type	Retrieve branch object by branch type
get_rank	Retrieve a rank object from given branch by name
is_spawn_branch	Return a true value if branch_name is a valid spawn branch key
is_spawn_rank	Return a true value if rank_name is a valid spawn rank in branch under branch_name
populate_branches	Populate the map branches list
preferences_key	Must be a filename-safe string. In future if map paths get funky, do some sanitization here.
setup_admin_faxes	Generates the default admin faxes addresses
spawn_branches	Return all spawn branches for the given input
spawn_planet_templates	Spawns all the templates in the given list, one after the other
spawn_ranks	Return all spawn ranks for the given input

Var Details

var
_available_backpacks
– /list

Decl list of backpacks available to outfits and in character generation.

var
branch_types
– /list

list of branch datum paths for military branches available on this map

var
branches
– /list

All branches that exist on this map

var
default_job_title
–

Default job title which will be set in some cases.

var
default_job_type
– /datum/job

Default job type which will be used if map lack of any jobs or for respawn.

var
default_liquid_fuel_type
–

A reagent used to prefill lanterns.

var
disconnected_disposals_tags
– /list

A list of disposals tags (sort_type var) that aren't expected to have outputs.

var
disconnected_wires_test_exempt_turfs
– /list

A list of lists, of the format ((x, y, z, dir),).

var
loadout_categories
– /list/decl/loadout_category

A list of /decl/loadout_category types which will be available for characters made on this map. Uses all categories if null.

var
map_admin_faxes
– /list

Associative list of network URIs to a list with their display name, color, and "req_access formated" needed access list. EX: list("BIG_BOSS.COM" = list("name" = "Big boss", "color" = "#00ff00", "access" = list(list(access_heads, access_clown))))

var
planet_depth
–

The amount of z-levels generated for exoplanets. Default is 1. Be careful with this, since exoplanets are already pretty expensive.

var
shuttle_atmos_expectation
–

Defines the expected result of the atmospherics shuttle unit test for atmosphere.

var
spawn_branches_
– /list

Branches that a player can choose for spawning on this map, not including species restrictions.

var
spawn_branches_by_species_
– /list

Branches that a player can choose for spawning on this map, with species restrictions. Populated on an as-needed basis

var
survival_box_choices
– /list/decl/survival_box_option

A list of survival box types selectable for this map. If null, defaults to all defined decls. At runtime, this is an associative list of decl type -> decl.

Proc Details

proc
generate_planet_spawn_lists
(/list/planets_templates, /list/planets_spawn_weight, /list/guaranteed_planets)

Fill up the list of planet_spawn_weight and guaranteed_planets

proc
get_all_planet_templates
()

Returns an associative list of all the planet templates we get to pick from. The key is the template name, and the value is the template instance.

proc
get_branch
(branch_name)

Retrieve branch object by branch name

proc
get_branch_by_type
(branch_type)

Retrieve branch object by branch type

proc
get_rank
(branch_name, rank_name)

Retrieve a rank object from given branch by name

proc
is_spawn_branch
(branch_name, /decl/species/S)

Return a true value if branch_name is a valid spawn branch key

proc
is_spawn_rank
(branch_name, rank_name, /decl/species/S)

Return a true value if rank_name is a valid spawn rank in branch under branch_name

proc
populate_branches
()

Populate the map branches list

proc
preferences_key
()

Must be a filename-safe string. In future if map paths get funky, do some sanitization here.

proc
setup_admin_faxes
()

Generates the default admin faxes addresses

proc
spawn_branches
(/decl/species/S)

Return all spawn branches for the given input

proc
spawn_planet_templates
(/list/templates_to_spawn)

Spawns all the templates in the given list, one after the other

proc
spawn_ranks
(branch_name, /decl/species/S)

Return all spawn ranks for the given input

map /datum/map

Vars

Procs

Var Details

var _available_backpacks – /list

var branch_types – /list

var branches – /list

var default_job_title –

var default_job_type – /datum/job

var default_liquid_fuel_type –

var disconnected_disposals_tags – /list

var disconnected_wires_test_exempt_turfs – /list

var loadout_categories – /list/decl/loadout_category

var map_admin_faxes – /list

var planet_depth –

var shuttle_atmos_expectation –

var spawn_branches_ – /list

var spawn_branches_by_species_ – /list

var survival_box_choices – /list/decl/survival_box_option

Proc Details

proc generate_planet_spawn_lists(/list/planets_templates, /list/planets_spawn_weight, /list/guaranteed_planets)

proc get_all_planet_templates()

proc get_branch(branch_name)

proc get_branch_by_type(branch_type)

proc get_rank(branch_name, rank_name)

proc is_spawn_branch(branch_name, /decl/species/S)

proc is_spawn_rank(branch_name, rank_name, /decl/species/S)

proc populate_branches()

proc preferences_key()

proc setup_admin_faxes()

proc spawn_branches(/decl/species/S)

proc spawn_planet_templates(/list/templates_to_spawn)

proc spawn_ranks(branch_name, /decl/species/S)