overmap

Vars
controlled_ships	List of all simulated ships. All ships in this list are fully initialized.
events	List of all events
events_enabled	Should events be processed
generator_type	Defines which generator to use for the overmap
outposts	List of spawned outposts. The default spawn location is the first index.
overmap_container	The two-dimensional list that contains every single tile in the overmap as a sublist.
overmap_objects	List of all overmap objects.
overmap_vlevel	The virtual level that contains the overmap
radius_positions	Map of tiles at each radius (represented by index) around the sun
ship_spawning	Whether or not a ship is currently being spawned. Used to prevent multiple ships from being spawned at once.
size	Width/height of the overmap "zlevel"
Procs
Initialize	Creates an overmap object for shuttles, triggers initialization procs for ships
create_map	The proc that creates all the objects on the overmap, split into seperate procs for redundancy.
get_num_cap_ships	Returns the number of ships on the overmap that count against the spawn cap.
get_overmap_object_by_location	Gets the parent overmap object (e.g. the planet the atom is on) for a given atom.
get_unused_overmap_square	Returns a random, usually empty turf in the overmap
get_unused_overmap_square_in_radius	Returns a random turf in a radius from the star, or a random empty turf if OVERMAP_GENERATOR_RANDOM is the active generator.
player_ship_spawn_allowed	Returns TRUE if players should be allowed to create a ship by "standard" means, and FALSE otherwise.
spawn_dynamic_encounter	Reserves a square dynamic encounter area, generates it, and spawns a ruin in it if one is supplied.
spawn_event_cluster	See /datum/controller/subsystem/overmap/proc/spawn_events, spawns "veins" (like ores) of events
spawn_events	VERY Simple random generation for overmap events, spawns the event in a random turf and sometimes spreads it out similar to ores
spawn_outpost	Creates a single outpost somewhere near the center of the system.
spawn_ruin_levels	Creates an overmap object for each ruin level, making them accessible.
spawn_ship_at_start	Spawns a controlled ship with the passed template at the template's preferred spawn location. Intended for ship purchases, etc.

Var Details

var
controlled_ships
– /list

List of all simulated ships. All ships in this list are fully initialized.

var
events
– /list

List of all events

var
events_enabled
–

Should events be processed

var
generator_type
–

Defines which generator to use for the overmap

var
outposts
– /list

List of spawned outposts. The default spawn location is the first index.

var
overmap_container
– /list/list

The two-dimensional list that contains every single tile in the overmap as a sublist.

var
overmap_objects
– /list

List of all overmap objects.

var
overmap_vlevel
– /datum/virtual_level

The virtual level that contains the overmap

var
radius_positions
– /list/list

Map of tiles at each radius (represented by index) around the sun

var
ship_spawning
–

Whether or not a ship is currently being spawned. Used to prevent multiple ships from being spawned at once.

var
size
–

Width/height of the overmap "zlevel"

Proc Details

Initialize
(start_timeofday)

Creates an overmap object for shuttles, triggers initialization procs for ships

proc
create_map
()

The proc that creates all the objects on the overmap, split into seperate procs for redundancy.

proc
get_num_cap_ships
()

Returns the number of ships on the overmap that count against the spawn cap.

proc
get_overmap_object_by_location
(/atom/source, exclude_ship)

Gets the parent overmap object (e.g. the planet the atom is on) for a given atom.

source - The object you want to get the corresponding parent overmap object for.

proc
get_unused_overmap_square
(thing_to_not_have, tries, force)

Returns a random, usually empty turf in the overmap

thing_to_not_have - The thing you don't want to be in the found tile, for example, an overmap event /datum/overmap/event.
tries - How many attempts it will try before giving up finding an unused tile.

proc
get_unused_overmap_square_in_radius
(radius, thing_to_not_have, tries, force)

Returns a random turf in a radius from the star, or a random empty turf if OVERMAP_GENERATOR_RANDOM is the active generator.

thing_to_not_have - The thing you don't want to be in the found tile, for example, an overmap event /datum/overmap/event.
tries - How many attempts it will try before giving up finding an unused tile..
radius - The distance from the star to search for an empty tile.

proc
player_ship_spawn_allowed
()

Returns TRUE if players should be allowed to create a ship by "standard" means, and FALSE otherwise.

proc
spawn_dynamic_encounter
(/datum/overmap/dynamic/dynamic_datum, ruin_type)

Reserves a square dynamic encounter area, generates it, and spawns a ruin in it if one is supplied.

on_planet - If the encounter should be on a generated planet. Required, as it will be otherwise inaccessible.
ruin_type - The type of ruin to spawn, or null if none should be placed.

proc
spawn_event_cluster
(/datum/overmap/event/type, /list/location, chance)

See /datum/controller/subsystem/overmap/proc/spawn_events, spawns "veins" (like ores) of events

proc
spawn_events
()

VERY Simple random generation for overmap events, spawns the event in a random turf and sometimes spreads it out similar to ores

proc
spawn_outpost
()

Creates a single outpost somewhere near the center of the system.

proc
spawn_ruin_levels
()

Creates an overmap object for each ruin level, making them accessible.

proc
spawn_ship_at_start
(/datum/map_template/shuttle/template)

Spawns a controlled ship with the passed template at the template's preferred spawn location. Intended for ship purchases, etc.

overmap /datum/controller/subsystem/overmap

Vars

Procs

Var Details

var controlled_ships – /list

var events – /list

var events_enabled –

var generator_type –

var outposts – /list

var overmap_container – /list/list

var overmap_objects – /list

var overmap_vlevel – /datum/virtual_level

var radius_positions – /list/list

var ship_spawning –

var size –

Proc Details

Initialize(start_timeofday)

proc create_map()

proc get_num_cap_ships()

proc get_overmap_object_by_location(/atom/source, exclude_ship)

proc get_unused_overmap_square(thing_to_not_have, tries, force)

proc get_unused_overmap_square_in_radius(radius, thing_to_not_have, tries, force)

proc player_ship_spawn_allowed()

proc spawn_dynamic_encounter(/datum/overmap/dynamic/dynamic_datum, ruin_type)

proc spawn_event_cluster(/datum/overmap/event/type, /list/location, chance)

proc spawn_events()

proc spawn_outpost()

proc spawn_ruin_levels()

proc spawn_ship_at_start(/datum/map_template/shuttle/template)