/datum/minimap_renderer
The minimap renderer is responsible for generating partial renders of area minimaps for each minimap type flag and generating
full renders of radar minimaps, alongside updating radar minimaps and dynamic area overlays. In the case of querying for area
minimaps, a minimap type bitflag may be passed to the renderer, which will then return a full render of the map comprised of
the aforementioned partial renders. In the case of querying for radar minimaps, a minimap atom/movable
will be returned,
containing both the radar map icon and the radar map markers.
Vars | |
dynamic_area_overlays | A list of dynamic area overlays for minimaps. Are overlays are indexed by z-level, type, and dynamic area group. |
---|---|
minimap_modifiers | A list of minimap render modifiers, sorted by priority. |
minimap_type_renders | A list of partial minimap renders for each minimap type flag. Icons are indexed by z-level and type. |
radar_minimap_objects_by_z_level | A list of radar minimap objects. Indexed by z-level. |
radar_minimaps_by_z_level | A list of radar minimap renders. Indexed by z-level. |
render_space_color | Does this minimap render space, if so - what color? Null if it renders space as black. |
Procs | |
generate_minimap_icons | Generates a list of /atom/movable objects for each z-level for a specified minimap type. |
get_minimap_dynamic_area_overlays | Returns a dynamic area overlay atom/movable for a specified minimap type. |
initialise_minimaps | Set up all /obj/minimap , /obj/minimap_controller , and /datum/minimap_marker/render types. |
recolor_area | Recolours a specified dynamic area group to a given colour. |
render_minimaps | Renders a minimap portion for each map flag, and renders dynamic area overlays, storing them in minimap_type_renders and dynamic_area_overlays respectively. |
render_radar_minimap | Initialises the radar minimap. |
separate_bitflag | Separates a given bitflag into a list of the separate bits composing it. Eg. 1011 -> (0001, 0010, 1000), or in base 10: 11 -> (1, 2, 8). |
turf_color | Determine the colour of a turf on the minimap. |
update_radar_map | Updates the pixel on a radar minimap render corresponding to the specified turf. |
valid_turf | Checks whether a turf should be rendered on the minimap through the minimaps_to_render_on bitflag on /area . |
Var Details
dynamic_area_overlays
A list of dynamic area overlays for minimaps. Are overlays are indexed by z-level, type, and dynamic area group.
minimap_modifiers
A list of minimap render modifiers, sorted by priority.
minimap_type_renders
A list of partial minimap renders for each minimap type flag. Icons are indexed by z-level and type.
radar_minimap_objects_by_z_level
A list of radar minimap objects. Indexed by z-level.
radar_minimaps_by_z_level
A list of radar minimap renders. Indexed by z-level.
render_space_color
Does this minimap render space, if so - what color? Null if it renders space as black.
Proc Details
generate_minimap_icons
Generates a list of /atom/movable
objects for each z-level for a specified minimap type.
get_minimap_dynamic_area_overlays
Returns a dynamic area overlay atom/movable
for a specified minimap type.
initialise_minimaps
Set up all /obj/minimap
, /obj/minimap_controller
, and /datum/minimap_marker/render
types.
recolor_area
Recolours a specified dynamic area group to a given colour.
render_minimaps
Renders a minimap portion for each map flag, and renders dynamic area overlays, storing them in minimap_type_renders
and dynamic_area_overlays
respectively.
render_radar_minimap
Initialises the radar minimap.
separate_bitflag
Separates a given bitflag into a list of the separate bits composing it. Eg. 1011 -> (0001, 0010, 1000), or in base 10: 11 -> (1, 2, 8).
turf_color
Determine the colour of a turf on the minimap.
update_radar_map
Updates the pixel on a radar minimap render corresponding to the specified turf.
valid_turf
Checks whether a turf should be rendered on the minimap through the minimaps_to_render_on
bitflag on /area
.