/datum/minimap

Minimap datums are responsible for handling the appearance of the minimap. This includes any displayed markers, the zoom level, and the displayed z-level.

Vars
map	The minimap, without minimap markers. Kept separate for the purpose of scaling the minimap without scaling the markers.
map_scale	The current scale of the physical map, as a multiple of the original size (300x300px).
marker_scale	The desired scale of the minimap markers, as a multiple of the original size (32x32px).
max_zoom	The maximum value which the zoom coefficient should be permitted to zoom to.
min_zoom	The minimum value which the zoom coefficient should be permitted to zoom to.
minimap_holder	The holder for the render of the minimap, allowing for offsets and other effects to be applied to the render without modifying the render itself.
minimap_markers	An associative list of all minimap markers the minimap is currently tracking and displaying, indexed by their target.
minimap_render	The minimap render to be displayed, containing both the map, dynamic area overlays, and markers.
x_max	The maximum x coordinate to be rendered, in world coordinates.
x_min	The minimum x coordinate to be rendered, in world coordinates.
y_max	The maximum y coordinate to be rendered, in world coordinates.
y_min	The minimum y coordinate to be rendered, in world coordinates.
z_level	The z-level that the minimap is to be rendered from.
zoom_coefficient	The scale that the minimap should be zoomed to; it does not affect the physical size of the minimap, as the alpha mask will take care of any map area scaled outside of the minimap boundaries.
Procs
create_alpha_mask	Create an alpha mask to hide anything outside the bounds of the physical map.
create_minimap_marker	Creates a minimap marker from a specified target, icon, and icon state. `marker_name` will override the marker inheriting the target's name.
initialise_minimap_render	Initialises the raw minimap icons and minimap render.
remove_minimap_marker	Removes a minimap marker from this minimap.
scale_map	Scale the map, while retaining the original (x, y) position of the bottom left corner.
set_marker_position	Sets the x and y position of a specified minimap marker, in world coordinates.
update_z_level	Updates the displayed z-level.
zoom_on_point	Zooms the minimap by the zoom coefficient while moving the minimap so that the specified point lies at the same position on the displayed minimap as it did prior to the zoom. The alpha mask takes care of any map area scaled outside of the map boundaries.

Var Details

var
map
– /atom/movable/minimap_render_object

The minimap, without minimap markers. Kept separate for the purpose of scaling the minimap without scaling the markers.

var
map_scale
–

The current scale of the physical map, as a multiple of the original size (300x300px).

var
marker_scale
–

The desired scale of the minimap markers, as a multiple of the original size (32x32px).

var
max_zoom
–

The maximum value which the zoom coefficient should be permitted to zoom to.

var
min_zoom
–

The minimum value which the zoom coefficient should be permitted to zoom to.

var
minimap_holder
– /atom/movable/minimap_render_object

The holder for the render of the minimap, allowing for offsets and other effects to be applied to the render without modifying the render itself.

var
minimap_markers
– /list/datum/minimap_marker/minimap

An associative list of all minimap markers the minimap is currently tracking and displaying, indexed by their target.

var
minimap_render
– /atom/movable/minimap_render_object

The minimap render to be displayed, containing both the map, dynamic area overlays, and markers.

var
x_max
–

The maximum x coordinate to be rendered, in world coordinates.

var
x_min
–

The minimum x coordinate to be rendered, in world coordinates.

var
y_max
–

The maximum y coordinate to be rendered, in world coordinates.

var
y_min
–

The minimum y coordinate to be rendered, in world coordinates.

var
z_level
–

The z-level that the minimap is to be rendered from.

var
zoom_coefficient
–

The scale that the minimap should be zoomed to; it does not affect the physical size of the minimap, as the alpha mask will take care of any map area scaled outside of the minimap boundaries.

Proc Details

proc
create_alpha_mask
()

Create an alpha mask to hide anything outside the bounds of the physical map.

proc
create_minimap_marker
(/atom/target, icon, icon_state, marker_name, can_be_deleted_by_player, list_on_ui)

Creates a minimap marker from a specified target, icon, and icon state. marker_name will override the marker inheriting the target's name.

proc
initialise_minimap_render
()

Initialises the raw minimap icons and minimap render.

proc
remove_minimap_marker
(/atom/target)

Removes a minimap marker from this minimap.

proc
scale_map
(scale)

Scale the map, while retaining the original (x, y) position of the bottom left corner.

proc
set_marker_position
(/datum/minimap_marker/minimap/map_marker, x, y, z)

Sets the x and y position of a specified minimap marker, in world coordinates.

proc
update_z_level
(z_level)

Updates the displayed z-level.

proc
zoom_on_point
(zoom, map_x, map_y)

Zooms the minimap by the zoom coefficient while moving the minimap so that the specified point lies at the same position on the displayed minimap as it did prior to the zoom. The alpha mask takes care of any map area scaled outside of the map boundaries.

/datum/minimap

Vars

Procs

Var Details

var map – /atom/movable/minimap_render_object

var map_scale –

var marker_scale –

var max_zoom –

var min_zoom –

var minimap_holder – /atom/movable/minimap_render_object

var minimap_markers – /list/datum/minimap_marker/minimap

var minimap_render – /atom/movable/minimap_render_object

var x_max –

var x_min –

var y_max –

var y_min –

var z_level –

var zoom_coefficient –

Proc Details

proc create_alpha_mask()

proc create_minimap_marker(/atom/target, icon, icon_state, marker_name, can_be_deleted_by_player, list_on_ui)

proc initialise_minimap_render()

proc remove_minimap_marker(/atom/target)

proc scale_map(scale)

proc set_marker_position(/datum/minimap_marker/minimap/map_marker, x, y, z)

proc update_z_level(z_level)

proc zoom_on_point(zoom, map_x, map_y)

var
map
– /atom/movable/minimap_render_object

var
map_scale
–

var
marker_scale
–

var
max_zoom
–

var
min_zoom
–

var
minimap_holder
– /atom/movable/minimap_render_object

var
minimap_markers
– /list/datum/minimap_marker/minimap

var
minimap_render
– /atom/movable/minimap_render_object

var
x_max
–

var
x_min
–

var
y_max
–

var
y_min
–

var
z_level
–

var
zoom_coefficient
–

proc
create_alpha_mask
()

proc
create_minimap_marker
(/atom/target, icon, icon_state, marker_name, can_be_deleted_by_player, list_on_ui)

proc
initialise_minimap_render
()

proc
remove_minimap_marker
(/atom/target)

proc
scale_map
(scale)

proc
set_marker_position
(/datum/minimap_marker/minimap/map_marker, x, y, z)

proc
update_z_level
(z_level)

proc
zoom_on_point
(zoom, map_x, map_y)