byond - Modules - TypesVar Details - Proc Details

Minimap

Default HUD screen minimap object

Vars

choices_by_mobassoc list of mob choices by clicking on coords. only exists fleetingly for the wait loop in [/proc/get_coords_from_click]
cur_x_shiftThe current x pixel shift
cur_y_shiftThe current y pixel shift
drawingIs drawing enbabled
labelled_turfsList of turfs that have labels attached to them. kept around so it can be cleared
liveIs the minimap live
max_scroll_ratioMax ratio to x_max/y_max you can scroll the map to
minimap_flagsMinimap flags
shift_sizeHow many pixels to shift each update
south_y_shiftWhether the vertical shift is currently pushing the map southward
stop_pollingassoc list to determine if get_coords_from_click should stop waiting for an input for that specific mob
targetMinimap target
west_x_shiftWhether the horizontal shift is currently pushing the map westward
x_maxThe horizontal max for this map (set at Initialize)
y_maxThe vertical max for this map (set at Initialize)

Procs

get_coords_from_clicklets the user get coordinates by clicking the actual map Returns a list(x_coord, y_coord) note: sleeps until the user makes a choice, stop_polling is set to TRUE for this specific user or they disconnect
on_clickHandles fetching the targetted coordinates when the mob tries to click on this map does the following: turns map targetted pixel into a list(x, y) gets z level of this map x and y minimap centering is reverted, then the x2 scaling of the map is removed round up to correct if an odd pixel was clicked and make sure its valid

Var Details

choices_by_mob

assoc list of mob choices by clicking on coords. only exists fleetingly for the wait loop in [/proc/get_coords_from_click]

cur_x_shift

The current x pixel shift

cur_y_shift

The current y pixel shift

drawing

Is drawing enbabled

labelled_turfs

List of turfs that have labels attached to them. kept around so it can be cleared

live

Is the minimap live

max_scroll_ratio

Max ratio to x_max/y_max you can scroll the map to

minimap_flags

Minimap flags

shift_size

How many pixels to shift each update

south_y_shift

Whether the vertical shift is currently pushing the map southward

stop_polling

assoc list to determine if get_coords_from_click should stop waiting for an input for that specific mob

target

Minimap target

west_x_shift

Whether the horizontal shift is currently pushing the map westward

x_max

The horizontal max for this map (set at Initialize)

y_max

The vertical max for this map (set at Initialize)

Proc Details

get_coords_from_click

lets the user get coordinates by clicking the actual map Returns a list(x_coord, y_coord) note: sleeps until the user makes a choice, stop_polling is set to TRUE for this specific user or they disconnect

on_click

Handles fetching the targetted coordinates when the mob tries to click on this map does the following: turns map targetted pixel into a list(x, y) gets z level of this map x and y minimap centering is reverted, then the x2 scaling of the map is removed round up to correct if an odd pixel was clicked and make sure its valid