minimap_display

Screen object that renders a /datum/minimap base map icon on the HUD.

Vars
active_button	Currently active toolbar button (the active tool).
annotation_share_tag	Optional group tag. Displays with the same tag share drawings and labels.
blips	Named blips indexed by name (added via add_blip()). Tagged blips are rebuilt from globals on z-level change.
can_draw	Whether this minimap instance allows drawing and labels.
draw_offset_y	Y-axis offset for drawing to account for mouse cursor icon positioning.
fixed_z_level	fixed z-level to stay on
hud_signals	list of signals we want to keep tied on the hud owner mob
locator_blip_tag	string for the locator blip's tag
minimap	A reference to the minimap used for this display.
screentip	Screentext in vis_contents used for the maptext.
toolbar_button_types	Maps HUD key → button type path. Used to create/remove toolbar buttons via /datum/hud.
valid_minimap_blip_tags	The list of minimap blip tags we're going to read from the globalist and listen for additions to
visible_minimap_elements	Unified list of currently visible minimap elements (drawings, labels, blips, screentip).
Procs
activate_button	Activates a toolbar button as the active tool.
add_blip	adds a local blip that's not added to the global list
deactivate_button	Deactivates the current tool button.
get_screen_pixel_size	Calculates the actual screen pixel size based on the client's view
set_cursor_icon	Sets the mouse cursor icon for the HUD client. Pass null to reset to default.

Var Details

var
active_button
– /atom/movable/screen/minimap_toolbar_button

Currently active toolbar button (the active tool).

var
annotation_share_tag

Optional group tag. Displays with the same tag share drawings and labels.

var
blips
– /list/atom/movable/screen/minimap_element/blip

Named blips indexed by name (added via add_blip()). Tagged blips are rebuilt from globals on z-level change.

var
can_draw

Whether this minimap instance allows drawing and labels.

var
draw_offset_y

Y-axis offset for drawing to account for mouse cursor icon positioning.

var
fixed_z_level

fixed z-level to stay on

var
hud_signals
– /list

list of signals we want to keep tied on the hud owner mob

var
locator_blip_tag

string for the locator blip's tag

var
minimap
– /datum/minimap

A reference to the minimap used for this display.

var
screentip
– /atom/movable/screen/minimap_element/label

Screentext in vis_contents used for the maptext.

var
toolbar_button_types
– /static/list

Maps HUD key → button type path. Used to create/remove toolbar buttons via /datum/hud.

var
valid_minimap_blip_tags
– /list

The list of minimap blip tags we're going to read from the globalist and listen for additions to

var
visible_minimap_elements
– /list/atom/movable/screen/minimap_element

Unified list of currently visible minimap elements (drawings, labels, blips, screentip).

Proc Details

proc
activate_button
(/atom/movable/screen/minimap_toolbar_button/button)

Activates a toolbar button as the active tool.

proc
add_blip
(name, icon_state, x, y, large, layer)

adds a local blip that's not added to the global list

proc
deactivate_button
()

Deactivates the current tool button.

proc
get_screen_pixel_size
()

Calculates the actual screen pixel size based on the client's view

proc
set_cursor_icon
(/icon/cursor_icon)

Sets the mouse cursor icon for the HUD client. Pass null to reset to default.

minimap_display /atom/movable/screen/minimap_display

Vars

Procs

Var Details

var active_button – /atom/movable/screen/minimap_toolbar_button

var annotation_share_tag

var blips – /list/atom/movable/screen/minimap_element/blip

var can_draw

var draw_offset_y

var fixed_z_level

var hud_signals – /list

var locator_blip_tag

var minimap – /datum/minimap

var screentip – /atom/movable/screen/minimap_element/label

var toolbar_button_types – /static/list

var valid_minimap_blip_tags – /list

var visible_minimap_elements – /list/atom/movable/screen/minimap_element