minimap

Minimap objects are responsible for displaying and handling player interaction with minimaps. They act as the physical manifestation of minimap datums, being displayed either on the map or in a UI element.

Vars
map	The minimap datum for this minimap object, containing data on the appearance and scale of the minimap, handling resizes, and managing markers.
map_path	The minimap type path that `map` should use.
map_scale	The desired scale of the physical map, as a multiple of the original size (300x300px).
map_type	A bitflag that will be passed to the datum and determines which areas and minimap markers are to be rendered on the minimap. For available flags, see `_std/defines/minimap.dm`.
Procs
initialise_minimap	Set up this minimap object's minimap datum and click overlay.

Var Details

var
map
– /datum/minimap

The minimap datum for this minimap object, containing data on the appearance and scale of the minimap, handling resizes, and managing markers.

var
map_path
–

The minimap type path that map should use.

var
map_scale
–

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

var
map_type
–

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

Proc Details

proc
initialise_minimap
()

Set up this minimap object's minimap datum and click overlay.

Station Map /obj/minimap

Vars

Procs

Var Details

var map – /datum/minimap

var map_path –

var map_scale –

var map_type –