/datum/minimap

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).
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 the targets and associated minimap markers the minimap is currently tracking and displaying.
minimap_render	The minimap render to be displayed, containing both the map, and icons.
minimap_type	A bitflag that determines which areas and minimap markers are to be rendered on the minimap. For available flags, see `_std/defines/minimap.dm`.
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.
set_marker_position	Sets the x and y position of a specified minimap marker, in world coordinates.
valid_turf	Checks whether a turf should be rendered on the map through the minimaps_to_render_on bitflag on /area.

Var Details

var
map
– /atom/movable

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
minimap_holder
– /atom/movable

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

An associative list of all the targets and associated minimap markers the minimap is currently tracking and displaying.

var
minimap_render
– /atom/movable

The minimap render to be displayed, containing both the map, and icons.

var
minimap_type
–

A bitflag that determines which areas and minimap markers are to be rendered on the minimap. For available flags, see _std/defines/minimap.dm.

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
set_marker_position
(/datum/minimap_marker/map_marker, x, y, z)

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

proc
valid_turf
(/turf/T)

Checks whether a turf should be rendered on the map through the minimaps_to_render_on bitflag on /area.

/datum/minimap

Vars

Procs

Var Details

var map – /atom/movable

var map_scale –

var marker_scale –

var minimap_holder – /atom/movable

var minimap_markers – /list

var minimap_render – /atom/movable

var minimap_type –

var x_max –

var x_min –

var y_max –

var y_min –

var z_level –

var zoom_coefficient –