overmap

Vars
encounter_cooldown	Cooldown on dynamically loading encounters
events	List of all events
events_enabled	Should events be processed
helms	List of all helms, to be adjusted
main	The main station or ship
navs	List of all nav computers to initialize
overmap_objects	List of all overmap objects
radius_tiles	Used for generating "orbits" via the solar generator Has tiles between index 1 and OVERMAP_DIMENSIONS, and a special "unsorted" key for tiles that don't fit in an orbit the latter being used primarily for oddities like wormholes. Map of tiles at each radius around the sun
simulated_ships	List of all active, simulated ships
size	Width/height of the overmap "zlevel"
Procs
Initialize	Creates an overmap object for shuttles, triggers initialization procs for ships and helms
create_map	The proc that creates all the objects on the overmap, split into seperate procs for redundancy.
get_overmap_object_by_id	Gets the corresponding overmap object that shares the provided ID
get_overmap_object_by_z	Gets the corresponding overmap object that shares the provided z level
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.
setup_shuttle_ship	Creates an overmap ship object for the provided mobile docking port if one does not already exist.
spawn_dynamic_encounter	Reserves a square dynamic encounter area, 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_ruin_levels	Creates an overmap object for each ruin level, making them accessible.
spawn_station	Creates a station and lavaland overmap object randomly on the overmap.

Var Details

var
encounter_cooldown
–

Cooldown on dynamically loading encounters

var
events
– /list

List of all events

var
events_enabled
–

Should events be processed

var
helms
– /list

List of all helms, to be adjusted

var
main
– /obj/structure/overmap

The main station or ship

var
navs
– /list

List of all nav computers to initialize

var
overmap_objects
– /list

List of all overmap objects

var
radius_tiles
– /list

Used for generating "orbits" via the solar generator Has tiles between index 1 and OVERMAP_DIMENSIONS, and a special "unsorted" key for tiles that don't fit in an orbit the latter being used primarily for oddities like wormholes. Map of tiles at each radius around the sun

var
simulated_ships
– /list

List of all active, simulated ships

var
size
–

Width/height of the overmap "zlevel"

Proc Details

Initialize
(start_timeofday)

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

proc
create_map
()

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

proc
get_overmap_object_by_id
(id)

Gets the corresponding overmap object that shares the provided ID

id - ID of the overmap object you want to find

proc
get_overmap_object_by_z
(zlevel)

Gets the corresponding overmap object that shares the provided z level

zlevel - The Z-level of the overmap object you want to find

proc
get_unused_overmap_square
(thing_to_not_have, tries)

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 /obj/structure/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)

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 /obj/structure/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
setup_shuttle_ship
(/obj/docking_port/mobile/shuttle)

Creates an overmap ship object for the provided mobile docking port if one does not already exist.

Shuttle: The docking port to create an overmap object for

proc
spawn_dynamic_encounter
(planet_type, ruin, dock_id, size, /obj/docking_port/mobile/visiting_shuttle, ignore_cooldown)

Reserves a square dynamic encounter area, 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.
target - The ruin to spawn, if any
dock_id - The id of the stationary docking port that will be spawned in the encounter. The primary and secondary prefixes will be applied, so do not include them.
size - Size of the encounter, defaults to 1/3 total world size
visiting_shuttle - The shuttle that is going to go to the encounter. Allows ruins to scale.

proc
spawn_event_cluster
(/obj/structure/overmap/event/type, /turf/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_ruin_levels
()

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

proc
spawn_station
(attempt)

Creates a station and lavaland overmap object randomly on the overmap.

attempt - Used for the failsafe respawning of the station. Don't set unless you want it to only try to spawn it once.

Overmap /datum/controller/subsystem/overmap

Vars

Procs

Var Details

var encounter_cooldown –

var events – /list

var events_enabled –

var helms – /list

var main – /obj/structure/overmap

var navs – /list

var overmap_objects – /list

var radius_tiles – /list

var simulated_ships – /list

var size –

Proc Details

Initialize(start_timeofday)

proc create_map()

proc get_overmap_object_by_id(id)

proc get_overmap_object_by_z(zlevel)

proc get_unused_overmap_square(thing_to_not_have, tries)

proc get_unused_overmap_square_in_radius(radius, thing_to_not_have, tries)

proc setup_shuttle_ship(/obj/docking_port/mobile/shuttle)

proc spawn_dynamic_encounter(planet_type, ruin, dock_id, size, /obj/docking_port/mobile/visiting_shuttle, ignore_cooldown)

proc spawn_event_cluster(/obj/structure/overmap/event/type, /turf/location, chance)

proc spawn_events()

proc spawn_ruin_levels()

proc spawn_station(attempt)