map_template 
Vars | |
| accessibility_weight | Percent of chances to end up onto a level from this template by spacewalking between space z-levels. |
|---|---|
| height | The height of the template's levels. Size is preloaded from template during template registration. |
| level_data_type | The initial type of level_data to instantiate new z-level with initially. (Is replaced by whatever is in the map file.) If null, will use default. |
| loaded | Amount of times this template was loaded at runtime. |
| mappaths | Path to the map files to load for this template. |
| modify_tag_vars | Will modify tag vars so that duplicate templates are handled properly. May have compatibility issues with legacy maps (esp. with ferry shuttles). |
| name | Name for differentiating templates |
| shuttles_to_initialise | Shuttles in this template's levels that need to be initialized with SSshuttle. |
| subtemplates_to_spawn | Sub-templates to spawn on this template if any. Ruins and sites and etc.. |
| tallness | The amount of template levels. Size is preloaded from template during template registration. |
| template_categories | List of strings to store the templates under for mass retrieval. |
| template_flags | Flags for defining special properties of this template. |
| template_parent_type | If this is equal to current type, the datum is abstract and should not be created. |
| template_tags | Various tags used for selecting templates for placement on a map. |
| width | The width of the template's levels. Size is preloaded from template during template registration. |
Procs | |
| is_runtime_generated | Returns whether a given map template is generated at runtime. Mainly used by unit tests. |
| load_new_z | Load the template onto a freshly created z-level. |
| load_single_path | Handle loading a single map path its bottom left corner starting at x,y,z. Returns a /datum/map_load_metadata if loading was successful. Meant to be overridden for handling extra per-map file processing. |
Var Details
accessibility_weight
Percent of chances to end up onto a level from this template by spacewalking between space z-levels.
height
The height of the template's levels. Size is preloaded from template during template registration.
level_data_type
The initial type of level_data to instantiate new z-level with initially. (Is replaced by whatever is in the map file.) If null, will use default.
loaded
Amount of times this template was loaded at runtime.
mappaths
Path to the map files to load for this template.
modify_tag_vars
Will modify tag vars so that duplicate templates are handled properly. May have compatibility issues with legacy maps (esp. with ferry shuttles).
name
Name for differentiating templates
shuttles_to_initialise
Shuttles in this template's levels that need to be initialized with SSshuttle.
subtemplates_to_spawn
Sub-templates to spawn on this template if any. Ruins and sites and etc..
tallness
The amount of template levels. Size is preloaded from template during template registration.
template_categories
List of strings to store the templates under for mass retrieval.
template_flags
Flags for defining special properties of this template.
template_parent_type
If this is equal to current type, the datum is abstract and should not be created.
template_tags
Various tags used for selecting templates for placement on a map.
width
The width of the template's levels. Size is preloaded from template during template registration.
Proc Details
is_runtime_generated
Returns whether a given map template is generated at runtime. Mainly used by unit tests.
load_new_z
Load the template onto a freshly created z-level.
- If centered is TRUE, the template's center will be aligned to the world's center. Otherwise, the template will load at pos 1,1.
load_single_path
Handle loading a single map path its bottom left corner starting at x,y,z. Returns a /datum/map_load_metadata if loading was successful. Meant to be overridden for handling extra per-map file processing.