minimap_controller

Minimap controllers are responsible for handling player manipulation of minimaps, including panning and zooming the map, managing minimap marker visibility, and creating and deleting markers.

Vars
controlled_minimap	The controlled minimap object.
displayed_minimap	The minimap to be displayed, mostly identical to the controlled minimap with the exception that the scale will always be 1. Used to circumvent a bug.
marker_silhouette	A semi-transparent minimap marker used to communicate where the marker will be placed on the minimap.
selected_icon	The icon that the marker silouette should use.
selected_x	The sampled x coordinate.
selected_y	The sampled y coordinate.
selecting_coordinates	Whether the next click will sample coordinates at the clicked point.
start_click_pos_x	The "starting" x position of the drag/pan, allowing for distance moved in the x axis to be calculated and applied to the minimap.
start_click_pos_y	The "starting" y position of the drag/pan, allowing for distance moved in the y axis to be calculated and applied to the minimap.
Procs
delete_marker	Deletes a minimap marker and removes it on the minimap.
initialise_minimap_controller	Set up this minimap controller's displayed minimap datum and click overlay.
new_marker	Creates a new minimap marker and displays it on the minimap.
pan_map	Pans the minimap by a specified number of pixels.
reset_scale	Resets the minimap to the defaut offset and zoom.
toggle_visibility	Toggles the visibility of a specified minimap marker.
toggle_visibility_all	Toggles the visibility of all minimap markers.

Var Details

var
controlled_minimap
– /obj/minimap

The controlled minimap object.

var
displayed_minimap
– /datum/minimap

The minimap to be displayed, mostly identical to the controlled minimap with the exception that the scale will always be 1. Used to circumvent a bug.

var
marker_silhouette
– /datum/minimap_marker/minimap

A semi-transparent minimap marker used to communicate where the marker will be placed on the minimap.

var
selected_icon
–

The icon that the marker silouette should use.

var
selected_x
–

The sampled x coordinate.

var
selected_y
–

The sampled y coordinate.

var
selecting_coordinates
–

Whether the next click will sample coordinates at the clicked point.

var
start_click_pos_x
–

The "starting" x position of the drag/pan, allowing for distance moved in the x axis to be calculated and applied to the minimap.

var
start_click_pos_y
–

The "starting" y position of the drag/pan, allowing for distance moved in the y axis to be calculated and applied to the minimap.

Proc Details

proc
delete_marker
(/datum/minimap_marker/marker)

Deletes a minimap marker and removes it on the minimap.

proc
initialise_minimap_controller
()

Set up this minimap controller's displayed minimap datum and click overlay.

proc
new_marker
(location, icon_state, name)

Creates a new minimap marker and displays it on the minimap.

proc
pan_map
(x, y)

Pans the minimap by a specified number of pixels.

proc
reset_scale
()

Resets the minimap to the defaut offset and zoom.

proc
toggle_visibility
(/datum/minimap_marker/minimap/marker_cm)

Toggles the visibility of a specified minimap marker.

proc
toggle_visibility_all
(visible)

Toggles the visibility of all minimap markers.

Map Controller /obj/minimap_controller

Vars

Procs

Var Details

var controlled_minimap – /obj/minimap

var displayed_minimap – /datum/minimap

var marker_silhouette – /datum/minimap_marker/minimap

var selected_icon –

var selected_x –

var selected_y –

var selecting_coordinates –

var start_click_pos_x –

var start_click_pos_y –