map_template

Vars
ceiling_baseturfs	What baseturfs to set when replacing openspace when has_ceiling is true
ceiling_turf	What turf to replace openspace with when has_ceiling is true
created_atoms	the list of atoms created by this template being loaded, only populated if returns_created_atoms is TRUE
default_area	Default area associated with the map template
has_ceiling	If true, any openspace turfs above the template will be replaced with ceiling_turf when loading. Should probably be FALSE for lower levels of multi-z ruins.
returns_created_atoms	if true, creates a list of all atoms created by this template loading, defaults to FALSE
should_place_on_top	if true, turfs loaded from this template are placed on top of the turfs already there, defaults to TRUE
Procs
discover_offset	Takes in a type path, locates an instance of that type in the cached map, and calculates its offset from the origin of the map, returns this offset in the form list(x, y).
load	Records where a template loaded on a station level, such as a random room or a holodeck program: its turfs aren't the station as the map built it, and take no graffiti (graffiti_static_station()). A template loaded where another one was, as a holodeck program is, replaces that record.

Var Details

var
ceiling_baseturfs
– /list

What baseturfs to set when replacing openspace when has_ceiling is true

var
ceiling_turf
– /turf

What turf to replace openspace with when has_ceiling is true

var
created_atoms
– /list

the list of atoms created by this template being loaded, only populated if returns_created_atoms is TRUE

var
default_area

Default area associated with the map template

var
has_ceiling

If true, any openspace turfs above the template will be replaced with ceiling_turf when loading. Should probably be FALSE for lower levels of multi-z ruins.

var
returns_created_atoms

if true, creates a list of all atoms created by this template loading, defaults to FALSE

var
should_place_on_top

if true, turfs loaded from this template are placed on top of the turfs already there, defaults to TRUE

Proc Details

proc
discover_offset
(/obj/marker)

Takes in a type path, locates an instance of that type in the cached map, and calculates its offset from the origin of the map, returns this offset in the form list(x, y).

proc
load
(/turf/origin, centered)

Records where a template loaded on a station level, such as a random room or a holodeck program: its turfs aren't the station as the map built it, and take no graffiti (graffiti_static_station()). A template loaded where another one was, as a holodeck program is, replaces that record.

Arguments:

origin: The turf it loads at.
centered: Whether origin is its centre rather than its low corner.

Returns:

list: The loaded bounds, as the parent returns them.
null: Nothing was loaded.

map_template /datum/map_template

Vars

Procs

Var Details

var ceiling_baseturfs – /list

var ceiling_turf – /turf

var created_atoms – /list

var default_area

var has_ceiling

var returns_created_atoms

var should_place_on_top